### GET /integration-guides/for-partners.md Source: https://integrations.impact.com/integration-guides/for-partners.md Queries the documentation dynamically by asking a question related to the integration guides. ```APIDOC ## GET /integration-guides/for-partners.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically when information is not explicitly present or clarification is needed. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-partners.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask, written in natural language. - **goal** (string) - Optional - Describes the broader end goal to help tailor the answer. ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/tango-card-integration-overview-for-advocate/integrate-with-tango-card-for-advocate-programs.md Use this request to ask specific questions about the integration guide and provide context for your end goal. ```http GET https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/tango-card-integration-overview-for-advocate/integrate-with-tango-card-for-advocate-programs.md?ask=&goal= ``` -------------------------------- ### GET /integration-guides/for-brands/advocate/build-a-custom-advocate-experience-with-graphql.md Source: https://integrations.impact.com/integration-guides/for-brands/advocate/build-a-custom-advocate-experience-with-graphql.md Perform a query against the documentation to retrieve information or clarification regarding the integration guide. ```APIDOC ## GET /integration-guides/for-brands/advocate/build-a-custom-advocate-experience-with-graphql.md ### Description Queries the documentation dynamically to retrieve information not explicitly present in the current page. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/advocate/build-a-custom-advocate-experience-with-graphql.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question in natural language. - **goal** (string) - Optional - The broader end goal to tailor the answer. ``` -------------------------------- ### GET /integration-guides/for-brands/tracking-integrations/google-tag-manager/introduction.md Source: https://integrations.impact.com/integration-guides/for-brands/tracking-integrations/google-tag-manager/introduction.md Query the documentation dynamically by asking a question related to the integration. ```APIDOC ## GET /integration-guides/for-brands/tracking-integrations/google-tag-manager/introduction.md ### Description Perform an HTTP GET request on the current page URL with the `ask` query parameter to retrieve information or clarification regarding the documentation. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/tracking-integrations/google-tag-manager/introduction.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask, written in natural language. - **goal** (string) - Optional - Describes the broader end goal to help tailor the answer. ``` -------------------------------- ### GET /rest-apis/api-quick-start/create-an-api-key.md Source: https://integrations.impact.com/rest-apis/api-quick-start/create-an-api-key.md Queries the documentation for specific information by providing a question and an optional goal. ```APIDOC ## GET /rest-apis/api-quick-start/create-an-api-key.md ### Description Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a natural language question. ### Method GET ### Endpoint https://integrations.impact.com/rest-apis/api-quick-start/create-an-api-key.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask the documentation. - **goal** (string) - Optional - The broader end goal to help tailor the response context. ### Request Example GET https://integrations.impact.com/rest-apis/api-quick-start/create-an-api-key.md?ask=How do I create an API key?&goal=Integrate with Impact API ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify/integrate-with-shopify-and-recharge-subscriptions.md Use this request to retrieve specific information or context regarding the Shopify and Recharge integration guide. ```http GET https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-shopify/integrate-with-shopify-and-recharge-subscriptions.md?ask=&goal= ``` -------------------------------- ### Query documentation via HTTP GET Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-tracking-integrations/advocate-installation-scripts.md Perform an HTTP GET request to query the documentation dynamically. ```http GET https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-tracking-integrations/advocate-installation-scripts.md?ask=&goal= ``` -------------------------------- ### GET /integration-guides/for-brands/advocate/mobile-options-for-advocate/branch-metrics-for-advocate.md Source: https://integrations.impact.com/integration-guides/for-brands/advocate/mobile-options-for-advocate/branch-metrics-for-advocate.md Queries the documentation dynamically by providing a question and an optional goal. ```APIDOC ## GET /integration-guides/for-brands/advocate/mobile-options-for-advocate/branch-metrics-for-advocate.md ### Description Queries the documentation dynamically to retrieve answers, relevant excerpts, and sources based on a specific question. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/advocate/mobile-options-for-advocate/branch-metrics-for-advocate.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### Branch and impact.com Data Mapping Examples Source: https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/mmp-mobile-measurement/integrate-with-branch.md Examples of query string parameters used for mapping Branch data to impact.com fields. ```json branch-custom=1&ItemCategory=%22%7Btest1%7D%22%2C%22%7Btest2%7D%22%2C%22%7Btest3%7D%22&ItemSubTotal=%22%7B21.6%7D%22%2C%22%7B20%7D%22%2C%22%7B891%7D%22&ItemSku=%22%7Bsku%7D%22%2C%22%7Bsku2%7D%22%2C%22%7Bsku3%7D%22&ItemQuantity=%22%7B1%7D%22%2C%22%7B2%7D%22%2C%22%7B1%7D%22 ``` ```json branch-custom=1&ItemCategory="{test1}","{test2}","{test3}"&ItemSubTotal="{21.6}","{20}","{891}"&ItemSku="{sku}","{sku2}","{sku3}"&ItemQuantity="{1}","{2}","{1}" ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://integrations.impact.com/brand-api-reference/reference/action-inquiries/action-inquiries.md Perform a GET request to the documentation URL with query parameters to retrieve specific information or context. ```http GET https://integrations.impact.com/brand-api-reference/reference/action-inquiries/action-inquiries.md?ask=&goal= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://integrations.impact.com/impact-brand/reference/api-open-endpoints Perform a GET request to the documentation index to retrieve answers based on a specific question and optional goal. ```http GET https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-api/api-open-endpoints.md?ask=&goal= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://integrations.impact.com/brand-api-reference Perform a GET request to the documentation index to retrieve answers based on a specific question and optional goal. ```http GET https://integrations.impact.com/integration-guides/for-brands/action-and-conversion-field-references.md?ask=&goal= ``` -------------------------------- ### Recompile project Source: https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-adobe-commerce-magento.md Compile the dependency injection configuration to finalize the plugin installation. ```shell $ bin/magento setup:di:compile ``` -------------------------------- ### GET / Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-tracking-integrations/integrate-google-tag-manager-with-advocate.md Perform a query against the documentation to retrieve answers and relevant excerpts. ```APIDOC ## GET / ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically for information. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-tracking-integrations/integrate-google-tag-manager-with-advocate.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask the documentation. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### GET /integration-guides/for-brands/action-and-conversion-field-references.md Source: https://integrations.impact.com/integration-guides/for-brands/action-and-conversion-field-references.md Queries the documentation dynamically by asking a question related to the content. ```APIDOC ## GET /integration-guides/for-brands/action-and-conversion-field-references.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically. This is useful when you need additional information, clarification, or context not explicitly present in the page. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/action-and-conversion-field-references.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask, written in natural language. - **goal** (string) - Optional - Describes the broader end goal to help tailor the answer. ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://integrations.impact.com/agency-v3/reference/reportexport/models.md Perform a GET request to the documentation URL with query parameters to receive an AI-generated answer based on the page content. ```http GET https://integrations.impact.com/agency-v3/reference/reportexport/models.md?ask=&goal= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://integrations.impact.com/partner-api-reference/reference/catalogs/models.md Perform an HTTP GET request to the current page URL to retrieve dynamic answers based on a specific question and goal. ```http GET https://integrations.impact.com/partner-api-reference/reference/catalogs/models.md?ask=&goal= ``` -------------------------------- ### GET /integration-guides/for-brands/plugin-integrations/crm-customer-relationship-management/integrate-with-hubspot.md Source: https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/crm-customer-relationship-management/integrate-with-hubspot.md Queries the documentation dynamically by providing a question and an optional goal. ```APIDOC ## GET /integration-guides/for-brands/plugin-integrations/crm-customer-relationship-management/integrate-with-hubspot.md ### Description Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/crm-customer-relationship-management/integrate-with-hubspot.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask, written in natural language. - **goal** (string) - Optional - The broader end goal to help tailor the answer. ``` -------------------------------- ### GET /brand-api-reference/readme/versioning.md Source: https://integrations.impact.com/brand-api-reference/readme/versioning.md Query the documentation dynamically by providing a question and an optional goal. ```APIDOC ## GET /brand-api-reference/readme/versioning.md ### Description Perform a query against the documentation to retrieve answers, excerpts, or sources related to a specific question. ### Method GET ### Endpoint https://integrations.impact.com/brand-api-reference/readme/versioning.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### GET /integration-guides/guides-quick-start.md Source: https://integrations.impact.com/integration-guides/guides-quick-start.md Queries the documentation dynamically by providing a question and an optional goal to receive a tailored response. ```APIDOC ## GET /integration-guides/guides-quick-start.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically. This allows for retrieving answers, clarifications, or related documentation sections. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/guides-quick-start.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to be answered, written in natural language. - **goal** (string) - Optional - Describes the broader end goal to help tailor the response. ``` -------------------------------- ### GET Method Postback URL Example Source: https://integrations.impact.com/brand-api-reference/reference/webhooks/enable-postbacks.md Example of a configured GET request URL with placeholders for dynamic event data. ```text [https://www.someadvertiser.com?myCampaignId=]{}{CAMPAIGNID}&theMpId={MEDIAPARTNERID}&theActionId={ACTIONID}&status={STATUS}&lockingDate={LOCKINGDATE}&mpPayout={PAYOUT}&saleAmt={AMOUNT} ``` ```text https://www.myadvertiser.com?myCampaignId=1000&theMpId=900&theActionId=12323&status=PENDING&lockingDate=2015-01-01&mpPayout=50.00&saleAmt=100.00 ``` -------------------------------- ### AppsFlyer Attribution Link Example Source: https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/mmp-mobile-measurement/integrate-with-appsflyer.md A sample single-platform attribution link used for tracking app installs. ```http app.appsflyer.com/id1486762009?af_siteid={irpid}&pid=impactradius_int&af_click_lookback=7d&clickid={clickid}&af_sub_siteid={sharedid}&c={iradname}&af_c_id={iradid}&is_retargeting=true&af_dp={gwlurl} ``` -------------------------------- ### GET /integration-guides/for-brands/tracking-integrations/javascript-tag-utt/installation.md Source: https://integrations.impact.com/integration-guides/for-brands/tracking-integrations/javascript-tag-utt/installation.md Queries the documentation for specific information using a natural language question and an optional goal context. ```APIDOC ## GET /integration-guides/for-brands/tracking-integrations/javascript-tag-utt/installation.md ### Description Queries the documentation dynamically by providing a specific question. The response includes a direct answer along with relevant excerpts and sources. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/tracking-integrations/javascript-tag-utt/installation.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask the documentation. - **goal** (string) - Optional - The broader end goal to help tailor the answer context. ``` -------------------------------- ### Executing a Passthrough Request with cURL Source: https://integrations.impact.com/agency-v3/readme/passthrough.md Example of a GET request to retrieve campaigns for a specific managed advertiser account. ```bash curl 'https://api.impact.com/Agencies//Advertisers/2747168/Campaigns' \ -X GET \ -u ':' \ -H 'Accept: application/json' ``` -------------------------------- ### Register the plugin Source: https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-adobe-commerce-magento.md Run the setup upgrade command to register the newly enabled plugin with the Adobe Commerce system. ```shell $ bin/magento setup:upgrade ``` -------------------------------- ### GET /your-configured-path Source: https://integrations.impact.com/partner-api-reference/reference/webhooks/event-notifications.md Receives an event notification from impact.com via a GET request to your configured URL. ```APIDOC ## GET /your-configured-path ### Description impact.com sends a GET request to your configured URL with event data as query-string parameters. This delivery mode is typically used for simple pixel-style integrations. ### Method GET ### Endpoint /your-configured-path ### Parameters #### Query Parameters - **campaign_id** (string) - Optional - Unique identifier of the brand program the event belongs to. - **action_id** (string) - Optional - Unique identifier of the tracked action. - **status** (string) - Optional - Status of the action at the time of notification (e.g., `APPROVED`, `PENDING`, `REVERSED`). - **payout** (string) - Optional - Commission amount paid to the partner for this action, as a decimal string. ### Response #### Success Response (200) - Your server has acknowledged the notification successfully. #### Success Response (202) - Accepted — same effect as 200 from impact.com's perspective. ``` -------------------------------- ### GET /rest-apis/api-quick-start.md Source: https://integrations.impact.com/rest-apis/api-quick-start.md Queries the documentation dynamically by providing a specific question and an optional goal to receive a tailored response. ```APIDOC ## GET /rest-apis/api-quick-start.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically for information not explicitly present in the page. ### Method GET ### Endpoint https://integrations.impact.com/rest-apis/api-quick-start.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask, written in natural language. - **goal** (string) - Optional - Describes the broader end goal to help tailor the response. ### Request Example GET https://integrations.impact.com/rest-apis/api-quick-start.md?ask=How do I authenticate?&goal=Integration setup ### Response #### Success Response (200) - **answer** (string) - A direct answer to the question. - **excerpts** (array) - Relevant excerpts from the documentation. - **sources** (array) - Sources used to generate the answer. ``` -------------------------------- ### GET / Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/klaviyo-for-advocate.md Perform an HTTP GET request on the documentation page URL to query information dynamically. ```APIDOC ## GET / ### Description Queries the documentation dynamically by providing a specific question and an optional end goal. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/klaviyo-for-advocate.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### Start Import Job via GraphQL Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-bulk-import-methods.md Initiates the import job using the createJob mutation. ```bash curl -X POST https://app.referralsaasquatch.com/api/v1/{tenant_alias}/graphql \ -u :{tenant_api_key} -H "Content-Type: application/json" -d '{ "variables":{ "jobInput": { "type":"{job_type}", "outputFormat":"CSV", "fileRef":"{file_ref}" } }, "query":"mutation ($jobInput: JobInput!) { createJob(jobInput: $jobInput) {id type requester dateCreated}}" }' ``` -------------------------------- ### GET /Mediapartners/{AccountSID}/WithdrawalSettings Source: https://integrations.impact.com/partner-api-reference/reference/withdrawal-settings/withdrawal-settings.md Returns the partner's current withdrawal settings, including bank account and payment scheduling information. ```APIDOC ## GET /Mediapartners/{AccountSID}/WithdrawalSettings ### Description Returns the partner's current withdrawal settings, including bank account and payment scheduling information. ### Method GET ### Endpoint /Mediapartners/{AccountSID}/WithdrawalSettings ### Parameters #### Path Parameters - **AccountSID** (string) - Required - Unique identifier for the partner account. ### Response #### Success Response (200) - **PaymentMethod** (string) - How impact.com sends your payouts. - **PaypalEmailAddress** (string) - Email address of the PayPal account that receives payouts. - **BankCountry** (string) - ISO 3166-1 alpha-2 country code of the country where the bank account is held. - **BeneficiaryAccountName** (string) - Full name on the bank account that will receive funds. - **BeneficiaryClassification** (string) - Classification of the account holder. - **ClassificationCode** (string) - Additional classification code required by some country/classification combinations. - **BeneficiaryAlternativeName** (string) - Alternative name on the account. - **BeneficiaryTaxPayerId** (string) - Taxpayer identifier of the beneficiary. - **BankAccountType** (string) - Type of bank account that will receive funds. - **BankAccountNumber** (string) - The bank account number that will receive funds. - **SwiftCode** (string) - SWIFT/BIC code identifying the receiving bank. - **RoutingCode** (string) - Domestic routing code for the receiving bank. - **VoCode** (string) - Country-specific verification code. - **AgencyCode** (string) - Bank agency identifier. - **BankAddress** (string) - Street address of the receiving bank branch. - **BankPostalCode** (string) - Postal code of the receiving bank branch. - **BankCity** (string) - City of the receiving bank branch. - **BankState** (string) - State or province of the receiving bank branch. - **BranchCode** (string) - Branch identifier code. - **BankName** (string) - Name of the receiving bank. - **BranchName** (string) - Name of the receiving bank's branch. - **PaymentSchedulingType** (string) - Determines whether payouts trigger by balance threshold or on a fixed day of the month. - **PaymentThreshold** (string) - Minimum account balance that triggers a payout. - **PaymentDay** (string) - Day of the month payouts are issued. - **Uri** (string) - API resource path for these withdrawal settings. ``` -------------------------------- ### GET /Mediapartners/{AccountSID}/WithdrawalSettings/RequiredFields Source: https://integrations.impact.com/partner-api-reference/reference/withdrawal-settings/withdrawal-settings.md Returns which fields are mandatory when configuring withdrawal settings for a given country and (optionally) payment method. ```APIDOC ## GET /Mediapartners/{AccountSID}/WithdrawalSettings/RequiredFields ### Description Returns which fields are mandatory when configuring withdrawal settings for a given country and (optionally) payment method. Always call this before updating settings for a country you haven't configured before. ### Method GET ### Endpoint /Mediapartners/{AccountSID}/WithdrawalSettings/RequiredFields ### Parameters #### Path Parameters - **AccountSID** (string) - Required - Unique identifier for the partner account. #### Query Parameters - **bankCountry** (string) - Required - ISO 3166-1 alpha-2 or alpha-3 country code where the bank account is held. - **paymentMethod** (string) - Optional - Filter the response to a single payment method (BANK_TRANSFER, PAYPAL). ### Response #### Success Response (200) - **BankCountry** (string) - Country the requirements apply to. - **Currency** (string) - Three-letter ISO 4217 currency code paid out for accounts in this country. - **PaymentMethods** (object) - Required-field listing keyed by payment method. ``` -------------------------------- ### Query documentation via HTTP GET Source: https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-nopcommerce.md Use this request to ask specific questions about the integration documentation dynamically. ```http GET https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/e-commerce/integrate-with-nopcommerce.md?ask=&goal= ``` -------------------------------- ### GET /brand-api-reference/reference/report-export.md Source: https://integrations.impact.com/brand-api-reference/reference/report-export.md Query the documentation dynamically by performing an HTTP GET request on the page URL. ```APIDOC ## GET /brand-api-reference/reference/report-export.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically. ### Method GET ### Endpoint https://integrations.impact.com/brand-api-reference/reference/report-export.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask, written in natural language. - **goal** (string) - Optional - Describes the broader end goal to tailor the answer. ``` -------------------------------- ### GET /brand-api-reference/reference/page-load.md Source: https://integrations.impact.com/brand-api-reference/reference/page-load.md Query the documentation dynamically by performing an HTTP GET request on the page URL. ```APIDOC ## GET /brand-api-reference/reference/page-load.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically. ### Method GET ### Endpoint https://integrations.impact.com/brand-api-reference/reference/page-load.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask. - **goal** (string) - Optional - The broader end goal to help tailor the answer. ``` -------------------------------- ### GET /ai-solutions/mcp-quick-start.md Source: https://integrations.impact.com/ai-solutions/mcp-quick-start.md Queries the documentation page for information by providing a specific question and an optional end goal. ```APIDOC ## GET /ai-solutions/mcp-quick-start.md ### Description Performs a dynamic query against the documentation page to retrieve answers, excerpts, and sources based on a natural language question. ### Method GET ### Endpoint https://integrations.impact.com/ai-solutions/mcp-quick-start.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask the documentation. - **goal** (string) - Optional - The broader end goal to help tailor the response context. ``` -------------------------------- ### GET /brand-api-reference/readme/requests.md Source: https://integrations.impact.com/brand-api-reference/readme/requests.md Query the documentation dynamically by performing a GET request on the documentation page URL. ```APIDOC ## GET /brand-api-reference/readme/requests.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically. ### Method GET ### Endpoint https://integrations.impact.com/brand-api-reference/readme/requests.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask. - **goal** (string) - Optional - The broader end goal to help tailor the answer. ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-tracking-integrations/sftp-import-integration-for-advocate-programs.md Use this request to ask specific questions about the integration documentation by appending the ask and goal parameters to the page URL. ```http GET https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-tracking-integrations/sftp-import-integration-for-advocate-programs.md?ask=&goal= ``` -------------------------------- ### GET /agency-v3/readme/passthrough.md Source: https://integrations.impact.com/agency-v3/readme/passthrough.md Query the documentation dynamically by performing a GET request on the documentation page URL. ```APIDOC ## GET /agency-v3/readme/passthrough.md ### Description Queries the documentation dynamically to retrieve information not explicitly present in the page. ### Method GET ### Endpoint https://integrations.impact.com/agency-v3/readme/passthrough.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific question to ask. - **goal** (string) - Optional - The broader end goal for the query. ``` -------------------------------- ### Verify Referral URL Parameters Source: https://integrations.impact.com/integration-guides/for-brands/advocate/end-to-end-testing-for-advocate.md Example of the expected landing page URL structure containing necessary referral parameters. ```text example.com/landing-page?utm_source=xxxx&utm_medium=xxxx&utm_campaign=saasquatch&rsCode=xxxxxx&rsShareMedium=xxxx&rsEngagementMedium=xxxx&_saasquatch=xxxxx ``` -------------------------------- ### GET /Call Data Source: https://integrations.impact.com/brand-api-reference/reference/call-data.md Logs call data from a call tracking provider using a GET request. ```APIDOC ## GET /Call Data ### Description Logs call data from call tracking providers into the impact.com system. ### Method GET ### Endpoint /Call Data ### Query Parameters - **call data** (string) - Required - The call data specified in the request parameter. ``` -------------------------------- ### GET /integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-salesforce-for-advocate/example-salesforce-flows-for-advocate.md Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-salesforce-for-advocate/example-salesforce-flows-for-advocate.md Queries the documentation dynamically by providing a specific question and an optional goal to receive a contextual answer. ```APIDOC ## GET /integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-salesforce-for-advocate/example-salesforce-flows-for-advocate.md ### Description Performs a dynamic query against the documentation to retrieve an answer and relevant excerpts based on a natural language question. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-salesforce-for-advocate/example-salesforce-flows-for-advocate.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained natural language question. - **goal** (string) - Optional - The broader end goal to help tailor the answer. ``` -------------------------------- ### JavaScript Redirect Example Source: https://integrations.impact.com/integration-guides/for-brands/tracking-integrations/troubleshoot-ios-universal-links-and-redirects.md Example of a client-side JavaScript redirect that often breaks Universal Link invocation. ```javascript window.location.href = "https://brand.com/promo"; ``` -------------------------------- ### Query Documentation Dynamically Source: https://integrations.impact.com/agency-v3/readme/versioning.md Perform an HTTP GET request with ask and goal parameters to retrieve information from the documentation. ```http GET https://integrations.impact.com/agency-v3/readme/versioning.md?ask=&goal= ``` -------------------------------- ### GET /brand-api-reference/advocate-api-reference-v1/reference/share-links-overview/models.md Source: https://integrations.impact.com/brand-api-reference/advocate-api-reference-v1/reference/share-links-overview/models.md Perform an HTTP GET request on the documentation page URL to query for additional information dynamically. ```APIDOC ## GET /brand-api-reference/advocate-api-reference-v1/reference/share-links-overview/models.md ### Description Query the documentation dynamically by providing a specific question and an optional goal to retrieve relevant excerpts and answers. ### Method GET ### Endpoint https://integrations.impact.com/brand-api-reference/advocate-api-reference-v1/reference/share-links-overview/models.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask the documentation. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### POST /{tenant_alias}/open/account/{accountId}/user/{userId} Source: https://integrations.impact.com/brand-api-reference/advocate-api-reference-v1/reference/user-overview/user.md Creates a user and an account. This operation requires either a write token or an API key. ```APIDOC ## POST /{tenant_alias}/open/account/{accountId}/user/{userId} ### Description This method creates a user and an account and returns the user object representing that newly created user/account. Because this call creates a user, it requires either a write token or an API key. ### Method POST ### Endpoint /{tenant_alias}/open/account/{accountId}/user/{userId} ### Parameters #### Path Parameters - **tenant_alias** (string) - Required - The tenant identifier. - **accountId** (string) - Required - The account identifier. - **userId** (string) - Required - The user identifier. ### Response #### Success Response (201) - **OpenUser** (object) - Information about the newly created user. #### Error Response (403) - **Error** (object) - Forbidden/Endpoint Disabled ``` -------------------------------- ### GET https://integrations.impact.com/agency-v3/readme/responses.md Source: https://integrations.impact.com/agency-v3/readme/responses.md Query the documentation dynamically by performing an HTTP GET request on the documentation page URL. ```APIDOC ## GET https://integrations.impact.com/agency-v3/readme/responses.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically. ### Method GET ### Endpoint https://integrations.impact.com/agency-v3/readme/responses.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask the documentation. - **goal** (string) - Optional - The broader end goal to tailor the answer. ``` -------------------------------- ### Get Exception List Details OpenAPI Specification Source: https://integrations.impact.com/brand-api-reference/reference/exception-lists/exception-lists.md Defines the ExceptionList schema and the GET endpoint for retrieving details by ID. ```json {"openapi":"3.1.0","info":{"title":"Brand API - Exception Lists","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"ExceptionList":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the exception list."},"Name":{"type":"string","description":"The display name for the exception list."},"State":{"type":"string","description":"The current state of the exception list.","enum":["ACTIVE","CLOSED","DEACTIVATED"]},"CampaignId":{"type":"integer","description":"The program ID the list applies to."},"Type":{"type":"string","description":"Whether the list applies to CATEGORY or SKU.","enum":["CATEGORY","SKU"]},"CreatedDate":{"type":"string","format":"date-time","description":"The date and time the list was created."},"DeactivationDate":{"type":"string","format":"date-time","nullable":true,"description":"The date and time the list was deactivated, if applicable."},"ActionTrackers":{"type":"array","description":"The action trackers (event types) this list applies to.","items":{"type":"object","properties":{"Id":{"type":"integer","description":"The unique identifier for the action tracker."},"Name":{"type":"string","description":"The display name of the action tracker."}}}},"NumberOfItems":{"type":"integer","description":"The total number of items in the list."},"ItemsUri":{"type":"string","format":"uri-reference","description":"The unique reference to the items collection for this list."},"Uri":{"type":"string","format":"uri-reference","description":"The unique reference to this exception list in the impact.com API."}}}}},"paths":{"/Advertisers/{AccountSID}/ExceptionLists/{ExceptionListId}":{"get":{"summary":"Get Exception List Details","description":"Retrieves the details of an existing exception list by its unique ID.","operationId":"getExceptionListById","tags":["Exception Lists"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"ExceptionListId","in":"path","required":true,"description":"The unique identifier for the exception list.","schema":{"type":"integer"}}],"responses":{"200":{"description":"A single exception list object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ExceptionList"}}}}}}}} ``` -------------------------------- ### GET /integration-guides/for-brands/advocate/mobile-options-for-advocate/appsflyer-for-advocate.md Source: https://integrations.impact.com/integration-guides/for-brands/advocate/mobile-options-for-advocate/appsflyer-for-advocate.md Query the documentation dynamically by asking a question related to the AppsFlyer integration. ```APIDOC ## GET /integration-guides/for-brands/advocate/mobile-options-for-advocate/appsflyer-for-advocate.md ### Description Perform a query against the documentation to retrieve specific information or clarification regarding the AppsFlyer integration. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/advocate/mobile-options-for-advocate/appsflyer-for-advocate.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific question to ask regarding the documentation. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://integrations.impact.com/partner-api-reference/reference/webhooks/event-notifications.md Perform an HTTP GET request to the page URL to retrieve answers to specific questions. ```http GET https://integrations.impact.com/partner-api-reference/reference/webhooks/event-notifications.md?ask=&goal= ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/cdp-customer-data-platform/integrate-with-segment.md Use this request to ask specific questions about the documentation and provide an optional goal for context. ```http GET https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/cdp-customer-data-platform/integrate-with-segment.md?ask=&goal= ``` -------------------------------- ### GET Integration Method Source: https://integrations.impact.com/brand-api-reference/reference/webhooks/set-up-postbacks-for-partners.md The GET method is the preferred option for most integrations, allowing parameters to be passed directly within the URL string. ```APIDOC ## GET [URL] ### Description The GET method allows you to pass optional parameters directly within the URL string as query parameters to track actions. ### Method GET ### Endpoint https://www.someadvertiser.com ### Query Parameters - **myCampaignId** (string) - Required - The campaign identifier. - **theMpId** (string) - Required - The media partner identifier. - **theActionId** (string) - Required - The action identifier. - **status** (string) - Required - The current status of the action. - **lockingDate** (string) - Required - The date the action locks. - **mpPayout** (string) - Required - The payout amount. - **saleAmt** (string) - Required - The total sale amount. ### Request Example https://www.someadvertiser.com?myCampaignId={CampaignId}&theMpId={MediaPartnerId}&theActionId={ActionId}&status={Status}&lockingDate={LockingDate}&mpPayout={Payout}&saleAmt={Amount} ``` -------------------------------- ### GET /integration-guides/for-brands/advocate/advocate-bulk-import-methods.md Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-bulk-import-methods.md Queries the documentation page for specific information using natural language. ```APIDOC ## GET /integration-guides/for-brands/advocate/advocate-bulk-import-methods.md ### Description Perform a query against the documentation page to retrieve answers, excerpts, or sources based on a natural language question. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-bulk-import-methods.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained natural language question. - **goal** (string) - Optional - The broader end goal to help tailor the response context. ### Request Example GET https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-bulk-import-methods.md?ask=How do I perform a bulk import?&goal=Onboarding new advocates ``` -------------------------------- ### GET /integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-salesforce-for-advocate.md Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-salesforce-for-advocate.md Queries the documentation page dynamically to retrieve answers, excerpts, and sources based on a specific question. ```APIDOC ## GET /integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-salesforce-for-advocate.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically. This allows users to ask specific questions and receive answers along with relevant excerpts and sources. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-salesforce-for-advocate.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask, written in natural language. - **goal** (string) - Optional - Describes the broader end goal to help tailor the answer. ``` -------------------------------- ### GET /brand-api-reference/advocate-api-reference-v1/reference/webhook-overview/models.md Source: https://integrations.impact.com/brand-api-reference/advocate-api-reference-v1/reference/webhook-overview/models.md Perform an HTTP GET request on the current page URL with the ask query parameter to query the documentation dynamically. ```APIDOC ## GET /brand-api-reference/advocate-api-reference-v1/reference/webhook-overview/models.md ### Description Query the documentation dynamically by asking a question related to the content. ### Method GET ### Endpoint https://integrations.impact.com/brand-api-reference/advocate-api-reference-v1/reference/webhook-overview/models.md ### Parameters #### Query Parameters - **ask** (string) - Required - The immediate question to ask. - **goal** (string) - Optional - The broader end goal to accomplish. ``` -------------------------------- ### GET /integration-guides/for-brands/advocate/advocate-api/api-webhooks-for-advocate-programs.md Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-api/api-webhooks-for-advocate-programs.md Queries the documentation dynamically by providing a specific question and an optional goal. ```APIDOC ## GET /integration-guides/for-brands/advocate/advocate-api/api-webhooks-for-advocate-programs.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically. This allows for retrieving specific information, clarifications, or related documentation sections. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-api/api-webhooks-for-advocate-programs.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question written in natural language. - **goal** (string) - Optional - Describes the broader end goal to help tailor the answer. ``` -------------------------------- ### Query Documentation via HTTP GET Source: https://integrations.impact.com/partner-api-reference/readme/pagination.md Use this request to ask specific questions about the documentation content dynamically. ```http GET https://integrations.impact.com/partner-api-reference/readme/pagination.md?ask=&goal= ``` -------------------------------- ### GET /partner-api-reference/reference/jobs-management/models.md?ask=&goal= Source: https://integrations.impact.com/partner-api-reference/reference/jobs-management/models.md Query the documentation dynamically by performing an HTTP GET request on the documentation page URL. ```APIDOC ## GET /partner-api-reference/reference/jobs-management/models.md ### Description Perform an HTTP GET request on the current page URL to query the documentation dynamically using natural language. ### Method GET ### Endpoint https://integrations.impact.com/partner-api-reference/reference/jobs-management/models.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask. - **goal** (string) - Optional - Describes the broader end goal to tailor the answer. ``` -------------------------------- ### GET /integration-guides/for-brands/plugin-integrations/subscriptions-and-payments/integrate-with-chargebee.md Source: https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/subscriptions-and-payments/integrate-with-chargebee.md Queries the documentation for specific information by providing a question and an optional goal. ```APIDOC ## GET /integration-guides/for-brands/plugin-integrations/subscriptions-and-payments/integrate-with-chargebee.md ### Description Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/plugin-integrations/subscriptions-and-payments/integrate-with-chargebee.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask the documentation. - **goal** (string) - Optional - The broader end goal to help tailor the response context. ``` -------------------------------- ### Get Contact Details OpenAPI Specification Source: https://integrations.impact.com/brand-api-reference/reference/contacts/contacts.md The OpenAPI definition for the Get Contact Details endpoint, including security requirements and the Contact schema. ```json {"openapi":"3.1.0","info":{"title":"Brand API - Contacts","version":"v14"},"servers":[{"url":"https://api.impact.com"}],"security":[{"basicAuth":[]}],"components":{"securitySchemes":{"basicAuth":{"type":"http","scheme":"basic","description":"Use your AccountSID as the username and AuthToken as the password."}},"schemas":{"Contact":{"type":"object","properties":{"Id":{"type":"string","description":"Unique Contact ID. System-created contacts are prefixed with 'M'."},"FirstName":{"type":"string"},"LastName":{"type":"string"},"EmailAddress":{"type":"string","format":"email"},"Title":{"type":"string","nullable":true},"ProfileImage":{"type":"string","format":"uri-reference"},"WorkPhoneNumberCountry":{"type":"string"},"WorkPhoneNumber":{"type":"string"},"CellphoneNumberCountry":{"type":"string"},"CellphoneNumber":{"type":"string"},"Editable":{"type":"boolean","description":"Indicates if the contact is user-created and fully editable (`true`) or system-created and partially editable (`false`)."},"Labels":{"type":"array","items":{"type":"string"}},"Accounts":{"type":"array","items":{"type":"object","properties":{"Id":{"type":"string"},"Name":{"type":"string"}}}},"Uri":{"type":"string","format":"uri-reference"}}}}},"paths":{"/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId}":{"get":{"summary":"Get Contact Details","description":"Retrieves the details of an existing contact by their unique impact.com Contact ID.","operationId":"getContactById","tags":["Contacts"],"parameters":[{"name":"AccountSID","in":"path","required":true,"schema":{"type":"string"}},{"name":"CampaignId","in":"path","required":true,"schema":{"type":"integer"}},{"name":"ContactId","in":"path","required":true,"description":"The unique identifier for the contact (e.g., '2750' or 'M1369520').","schema":{"type":"string"}}],"responses":{"200":{"description":"A single contact object.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Contact"}}}}}}}}} ``` -------------------------------- ### GET /integration-guides/for-brands/advocate/advocate-plugin-integration/klaviyo-for-advocate/set-up-your-klaviyo-notifications.md Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/klaviyo-for-advocate/set-up-your-klaviyo-notifications.md Perform a query on the current documentation page to retrieve information or clarification. ```APIDOC ## GET /integration-guides/for-brands/advocate/advocate-plugin-integration/klaviyo-for-advocate/set-up-your-klaviyo-notifications.md ### Description Queries the documentation dynamically to retrieve answers, excerpts, or context related to the page content. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/klaviyo-for-advocate/set-up-your-klaviyo-notifications.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific question to ask regarding the documentation. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### GET /integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-shopify-for-advocate.md Source: https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-shopify-for-advocate.md Queries the documentation for specific information by providing a question and an optional goal. ```APIDOC ## GET /integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-shopify-for-advocate.md ### Description Queries the documentation dynamically to retrieve answers, excerpts, and sources based on a specific question. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/advocate/advocate-plugin-integration/integrate-with-shopify-for-advocate.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask the documentation. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### GET /integration-guides/for-brands/tracking-integrations/configure-a-data-post-for-your-program.md Source: https://integrations.impact.com/integration-guides/for-brands/tracking-integrations/configure-a-data-post-for-your-program.md Queries the documentation for information by providing a specific question and an optional end goal. ```APIDOC ## GET /integration-guides/for-brands/tracking-integrations/configure-a-data-post-for-your-program.md ### Description Queries the documentation dynamically by asking a question to retrieve direct answers and relevant excerpts. ### Method GET ### Endpoint https://integrations.impact.com/integration-guides/for-brands/tracking-integrations/configure-a-data-post-for-your-program.md ### Parameters #### Query Parameters - **ask** (string) - Required - The specific, self-contained question to ask. - **goal** (string) - Optional - The broader end goal to help tailor the response. ``` -------------------------------- ### Query Documentation Dynamically Source: https://integrations.impact.com/brand-api-reference/reference/clicks.md Perform an HTTP GET request on the current page URL with the ask query parameter to retrieve information. ```http GET https://integrations.impact.com/brand-api-reference/reference/clicks.md?ask=&goal= ```