Skip to main content

Impact Brand

The impact.com Brand API lets brands (advertisers) manage their partnership and affiliate programs programmatically. Use it to work with partners, programs (campaigns), ads, and actions (conversion events), and to schedule report exports. Authentication is HTTP Basic Auth using your Account SID as the username and your Auth Token as the password.

Impact Brand icon

Power end-to-end data operations for your Impact Brand API with Nexla. Our bi-directional Impact Brand connector is purpose-built for Impact Brand, making it simple to ingest data, sync it across systems, and deliver it anywhere — all with no coding required. Nexla turns API-sourced data into ready-to-use, reusable data products and makes it easy to send data to Impact Brand or any other destination. With comprehensive monitoring, lineage tracking, and access controls, Nexla keeps your Impact Brand workflows fast, secure, and fully governed.

Features

Type: API

SourceDestination

  • Seamless API Integration: Connect to any endpoint as source or destination without coding, with automatic data product creation
  • Visual Composition & Chaining: Build complex integrations using visual templates, chain API calls, and compose workflows with data validation and filtering
  • API Proxy: Expose curated slices of your data securely with a secure and customizable API proxy that validates and transforms data on the fly
  • Request optimization with intelligent batching, retry, and caching to minimize API calls and costs

Prerequisites

Before creating an Impact Brand credential, you need an Account SID and an Auth Token from your impact.com brand account. The impact.com API uses these two values for HTTP Basic Authentication: the Account SID is sent as the username and the Auth Token is sent as the password. The Account SID also appears as the {AccountSID} path segment in every API endpoint URL.

To obtain your credentials, follow these steps:

  1. Sign in to your impact.com brand account.

  2. From the top navigation bar, select your User profile, then select Settings.

  3. In the left column, scroll to the Technical section and select API.

  4. Locate an existing API access token, or select Create Access Token in the upper-right corner of the page to generate a new one. impact.com supports scoped tokens, which let you grant fine-tuned permissions that limit access to specific API endpoints.

  5. Use Copy next to the Account SID to copy the token's unique API identifier (used as the username).

  6. Use Copy next to the Auth Token to copy the secret value (used as the password).

  7. Store both values securely, as you will need them to configure your Nexla credential. The Auth Token is sensitive and should be kept confidential.

API tokens created before April 2025 are considered legacy tokens and are managed separately in the impact.com console. For complete information about creating and managing API access tokens, see the impact.com Brand API reference.

Authenticate

Credentials required

FieldRequiredSecretDescription
Account SIDYesNoimpact.com Account SID (used as the HTTP Basic username, and as the {AccountSID} path segment on every endpoint). Found in Impact console under Settings > Technical/API.
Auth TokenYesYesimpact.com Auth Token (used as the HTTP Basic password). Generated alongside the Account SID under Settings > Technical/API.

Create a credential in Nexla

  1. After selecting the data source/destination type, click the Add Credential tile to open the Add New Credential overlay.

  2. Enter a name for the credential in the Credential Name field and a short, meaningful description in the Credential Description field.

  3. Enter your impact.com Account SID in the Account SID field. This value is used as the HTTP Basic Auth username and forms part of every API endpoint URL.

  4. Enter your impact.com Auth Token in the Auth Token field. This value is used as the HTTP Basic Auth password and must be kept confidential.

    If your Auth Token is compromised, revoke it in your impact.com API settings and create a new access token. For detailed information about authentication and available endpoints, see the impact.com Brand API reference.

  5. Click the Save button at the bottom of the overlay. The newly added credential will now appear in a tile on the Authenticate screen during data source/destination creation.

Use as a data source

To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Select the Impact Brand connector tile, then select the credential that will be used to connect to impact.com, and click Next; or, create a new Impact Brand credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common Impact Brand endpoints. Select the endpoint from which this source will fetch data from the Endpoint pulldown menu. Available endpoint templates are listed in the expandable boxes below.

[Rest API] List Actions

Returns a list of actions (conversion events) your program has recorded, filtered by the provided parameters.

  • Optionally set the Start Date and End Date filters (ISO 8601) to bound the date range, and the Program ID Filter to limit results to a specific program (campaign).

[Rest API] Get Action

Retrieves details of a specific conversion event by its unique ID.

  • Enter the Action ID, the unique impact.com ID of the conversion/action event.

[Rest API] List Action Items

Returns line items (SKUs) within a specified conversion event.

  • Enter the Action ID, the unique impact.com ID of the conversion/action event.

[Rest API] Get Action Item

Retrieves details of a particular product line item within a conversion event.

  • Enter the Action ID of the conversion event and the SKU, the product / line-item identifier within that action.

[Rest API] List Action Updates

Returns a list of action updates, which serve as a changelog for actions.

  • Optionally set the Start Date and End Date filters (ISO 8601) to bound the date range of updates returned.

[Rest API] Get Action Update

Retrieves details for a specific modification event in an action's lifecycle.

  • Enter the Action Update ID, the unique ID of an action-update (changelog) event.

[Rest API] List Partners

Returns a list of all your partners, sorted by creation date.

  • Optionally set the Program ID Filter, Country Filter, and Relationship State Filter to narrow the partners returned.

[Rest API] Get Partner

Retrieves the details of an existing partner by their unique ID.

  • Enter the Partner ID, the unique impact.com ID of the media partner.

[Rest API] List Programs

Returns a list of all programs (campaigns) for your account, sorted by Program ID.

  • Optionally set the Name Filter and State Filter (for example ACTIVE, AWAITING_REVIEW, or CANCELLED) to narrow the programs returned.

[Rest API] Get Program

Retrieves the details of an existing program (campaign) by its unique ID.

  • Enter the Program (Campaign) ID, the unique impact.com ID of the program/campaign.

[Rest API] List Ads

Lists existing ads, returned by creation date with the most recently created ad appearing first.

  • Optionally set the Program ID Filter and Ad Type Filter (BANNER, TEXT_LINK, or COUPON) to narrow the ads returned.

[Rest API] Get Ad

Retrieves the details of an existing ad by its unique impact.com Ad ID.

  • Enter the Ad ID, the unique impact.com ID of the ad.

[Rest API] Export Report

Schedules a job to export a report; the response contains URIs to poll for job status and download the result.

  • Enter the Report ID or Handle (a numeric report ID or a string handle such as adv_click_data_pm_only). Most reports also require the Program ID, Start Date, and End Date (ISO 8601). Optionally set the Result Format to CSV, JSON, or XML (defaults to CSV).

Once the selected endpoint template has been configured, click the Test button to the right of the endpoint selection menu to retrieve a sample of the data that will be fetched. Sample data will be displayed in the Endpoint Test Result panel on the right, allowing you to verify that the source is configured correctly before saving.

Manual configuration

Impact Brand data sources can also be manually configured to ingest data from any valid impact.com Brand API endpoint, including endpoints not covered by the pre-built templates, chained API calls, or custom request parameters. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, endpoint URL, date/time and lookup macros, path to data, metadata, and request headers.

Once all of the relevant settings have been configured, click the Create button in the upper right corner of the screen to save and create the new Impact Brand data source. Nexla will now begin ingesting data from the configured endpoint and will organize any data that it finds into one or more Nexsets.

Use as a destination

Click the + icon on the Nexset that will be sent to the Impact Brand destination, and select the Send to Destination option from the menu. Select the Impact Brand connector from the list of available destination connectors, then select the credential that will be used to connect to impact.com, and click Next; or, create a new Impact Brand credential for use in this flow.

Endpoint templates

Nexla provides pre-built templates that can be used to rapidly configure destinations to send data to common Impact Brand endpoints. Select the endpoint to which data will be sent from the Endpoint pulldown menu. Then, click on the template in the list below to expand it, and follow the instructions to configure additional endpoint settings.

[Rest API] Update Action

Updates conversion event details or line-item information (ActionId/Sku identify the target in the body); returns queued status.

  • Each record from your Nexset is sent as the JSON request body to update the target action. Include the ActionId (and Sku for a line item) in the record to identify what to update.

[Rest API] Reverse Action

Reverses an action using its ActionId or a combination of ActionTrackerId and OrderId in the request body.

  • Each record from your Nexset is sent as the JSON request body identifying the action to reverse, either by ActionId or by ActionTrackerId plus OrderId.

[Rest API] Create Direct Partner

Creates a new direct partner account, which automatically joins your program with a specified active contract.

  • Each record from your Nexset is sent as the JSON request body describing the new direct partner, including the contract that the partner should join.

[Rest API] Update Partner Values

Updates the custom MPValue fields for a specified partner, used in tracking links.

  • Enter the Partner ID, the unique impact.com ID of the media partner. Each record from your Nexset is sent as the JSON request body containing the MPValue fields to update.

[Rest API] Create Ad

Creates a new Banner, Coupon, or Text Link ad.

  • Each record from your Nexset is sent as the JSON request body describing the ad to create, including its type and creative details.

[Rest API] Update Ad

Updates an existing ad, including its creative file if needed.

  • Enter the Ad ID, the unique impact.com ID of the ad. Each record from your Nexset is sent as the JSON request body containing the ad fields to update.

[Rest API] Create Conversion

Submits a conversion event (sale, lead, subscription) for tracking, attribution, and partner payment.

  • Each record from your Nexset is sent as the JSON request body describing the conversion event to submit for tracking and attribution.

Manual configuration

Impact Brand destinations can also be manually configured to send data to any valid impact.com Brand API endpoint. Select the Advanced tab at the top of the configuration screen, and follow the instructions in Connect to Any API to configure the API method, data format, endpoint URL, request headers, attribute exclusions, record batching, and response webhooks.

The impact.com Brand API expects JSON request bodies. For update operations, include the ID of the object being updated (for example the Partner ID or Ad ID) so the request targets the correct resource.

Save & activate

Once all endpoint settings have been configured, click the Done button in the upper right corner of the screen to save and create the destination. To send the data to the configured Impact Brand endpoint, open the destination resource menu, and select Activate.

The Nexset data will not be sent to the Impact Brand endpoint until the destination is activated. Destinations can be activated immediately or at a later time, providing full control over data movement.