Skip to main content

AWIN Advertiser Data Source

The AWIN Advertiser connector enables you to ingest performance reports, publisher relationships, and transaction data from your Awin advertiser account into Nexla. Follow the instructions below to create a new data flow that ingests data from an AWIN Advertiser source in Nexla.
awin_advertiser_api.png

AWIN Advertiser

Create a New Data Flow​

  1. To create a new data flow, navigate to the Integrate section, and click the New Data Flow button. Then, select the desired flow type from the list, and click the Create button.

  2. Select the AWIN Advertiser connector tile from the list of available connectors. Then, select the credential that will be used to connect to the AWIN Advertiser instance, and click Next; or, create a new AWIN Advertiser credential for use in this flow.

  3. In Nexla, AWIN Advertiser data sources can be created using pre-built endpoint templates, which expedite source setup for common AWIN Advertiser endpoints. Each template is designed specifically for the corresponding AWIN Advertiser endpoint, making source configuration easy and efficient.
    • To configure this source using a template, follow the instructions in Configure Using a Template.

    AWIN Advertiser sources can also be configured manually, allowing you to ingest data from AWIN Advertiser endpoints not included in the pre-built templates or apply further customizations to exactly suit your needs.
    • To configure this source manually, follow the instructions in Configure Manually.

Configure Using a Template​

Nexla provides pre-built templates that can be used to rapidly configure data sources to ingest data from common AWIN Advertiser endpoints. Each template is designed specifically for the corresponding AWIN Advertiser endpoint, making data source setup easy and efficient.

Endpoint Settings​

  • 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. Click on an endpoint to see more information about it and how to configure your data source for this endpoint.

    Get Campaign Performance

    This endpoint retrieves campaign performance metrics and statistics for the advertiser from the /advertisers/{'{advertiserId}'}/reports/campaign endpoint. Use this template when you need a paginated snapshot of campaign-level performance data without specifying a date window.

    • Enter your unique advertiser account identifier in the Advertiser ID field. This numeric ID is required and can be found in the URL of your Awin advertiser dashboard or under your account profile.
    • The Page field controls the starting page number for pagination. The default value of 1 is appropriate for most ingestion scenarios.
    • The Page Size field controls the number of records returned per page. The default value of 100 aligns with Awin's expected page size; lower values can be used when testing.

    Pagination automatically advances pages until an empty response is returned, so leaving the page and page size fields at their defaults is sufficient for most full-history ingestion runs.

    Get Advertiser Campaign Report

    This endpoint retrieves aggregated campaign performance data (clicks and transactions) by campaign and publisher for a specified date window. Use this template for time-bounded reporting and to break down campaign performance over daily, weekly, or monthly intervals.

    • Enter your Awin advertiser account ID in the Advertiser Id field.
    • Enter the report period start date in the Start Date field using the format YYYY-MM-DD (for example, 2026-01-01).
    • Enter the report period end date in the End Date field using the format YYYY-MM-DD.
    • Enter the timezone used for date calculations in the Timezone field (for example, UTC or America/New_York). This controls how Awin bucketizes daily, weekly, and monthly intervals.
    • Enter the date field used for filtering in the Date Type field. Common values are transaction (default in Awin) and click.
    • Enter the aggregation interval in the Interval field. Supported values are daily, weekly, and monthly.
    • Leave the Page and Page Size fields at their defaults (1 and 100) unless a smaller test batch is needed.

    Awin returns up to a maximum date range per call—check the Get Campaign Performance API reference for current limits. For long historical pulls, split the ingestion into multiple date windows.

    Get Publisher Performance Report

    This endpoint retrieves aggregated performance metrics—transactions, clicks, and impressions—for every publisher that your advertiser program works with. Use this template to analyze publisher contribution and to benchmark performance across regions.

    • Enter your Awin advertiser account ID in the Advertiser Id field.
    • Enter the start and end of the report period in the Start Date and End Date fields using YYYY-MM-DD format.
    • Enter the timezone used for date calculations in the Timezone field (for example, UTC).
    • Enter the date field used for filtering in the Date Type field (commonly transaction or click).
    • Enter an optional publisher region filter in the Region field to scope the report to a specific market (for example, US or UK). Leave blank to include all regions.
    • Leave the Page and Page Size fields at the defaults of 1 and 100 for full-result ingestion.

    The publisher report aggregates across the entire advertiser program. To track changes over time, schedule recurring ingestion runs with rolling date windows rather than a single one-off pull.

    Get Advertiser Transaction Job by ID

    This endpoint retrieves the status and error details for a single bulk transaction validation job. Use this template after submitting a batch validation request to check whether the job completed successfully or to inspect rejection reasons.

    • Enter your Awin advertiser account ID in the Advertiser Id field.
    • Enter the unique job identifier returned by Awin when the validation job was created in the Job Id field.

    Use the Get Advertiser Transaction Jobs endpoint to retrieve a paginated list of recent job IDs if the original job ID is not readily available.

    Get Advertiser Transactions by IDs

    This endpoint retrieves individual transactions for a given advertiser, filtered by a list of transaction IDs. Use this template to pull a targeted set of transactions for reconciliation, validation, or downstream enrichment.

    • Enter your Awin advertiser account ID in the Advertiser Id field.
    • Enter a comma-separated list of transaction IDs to retrieve in the Transaction IDs field (for example, 123456,123457,123458).
    • Enter the timezone for transaction dates in the Timezone field (for example, UTC).
    • Set the Show Basket Products field to true to include the basket-level product detail for each transaction. Leave blank or set to false to receive transaction summaries only.

    Returning basket products can significantly increase the response payload size. Enable this option only when product-level reporting is required.

    Get Accounts

    This endpoint retrieves the list of advertiser accounts accessible to the authenticated user from the /accounts?type=advertiser endpoint. Use this template to discover the Advertiser IDs that your API token can access before configuring other endpoints.

    • This endpoint requires no additional configuration. Select the template and click Test to retrieve the list of advertiser accounts visible to your API token.

    Use the accountId values returned from this endpoint as the Advertiser ID input for the campaign, publisher, and transaction endpoints.

    Get Advertiser Publishers

    This endpoint retrieves the list of publishers with active relationships for the given advertiser, including region and promotion type information. Use this template to maintain an up-to-date directory of partner publishers for your program.

    • Enter your Awin advertiser account ID in the Advertiser Id field.
    • The endpoint uses offset-based pagination internally and will automatically fetch additional pages until no more publishers are returned.

    Schedule this ingestion on a daily or weekly cadence to keep downstream publisher dimensions current as new partnerships are added or paused.

    Get Advertiser Transaction Jobs

    This endpoint retrieves bulk transaction validation job statuses for the given advertiser. Use this template to monitor the queue of validation jobs that you have submitted and to surface jobs that completed with errors.

    • Enter your Awin advertiser account ID in the Advertiser Id field.
    • Offset-based pagination automatically advances through the list of jobs until the API returns no further results.

    Combine the results of this endpoint with Get Advertiser Transaction Job by ID to programmatically inspect the success or failure of each batch validation request.

    List Transactions

    This endpoint retrieves a list of transactions for the advertiser account, filtered by date range. Use this template for incremental ingestion of transaction-level affiliate data into your warehouse or downstream attribution platform.

    • Enter your Awin advertiser account ID in the Advertiser ID field.
    • Enter the start of the date window in the Start Date field using the ISO datetime format yyyy-MM-ddTHH:mm:ss.
    • Enter the end of the date window in the End Date field using the ISO datetime format yyyy-MM-ddTHH:mm:ss.
    • Enter the date field used for filtering in the Date Type field. Supported values are transaction (default), click, and validation.
    • Enter the timezone for date filtering in the Timezone field. Defaults to UTC.
    • Leave Page Number and Page Size at the defaults to use the standard 100-record pagination, or override them if smaller test batches are needed.

    Awin enforces a maximum window of 31 days per request for the transactions endpoint. For longer ranges, schedule recurring runs that step through 31-day windows.

Endpoint Testing​

Once the selected endpoint template has been configured, Nexla can retrieve a sample of the data that will be fetched according to the current settings. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Configure Manually​

AWIN Advertiser data sources can be manually configured to ingest data from any valid AWIN Advertiser API endpoint. Manual configuration provides maximum flexibility for accessing endpoints not covered by pre-built templates or when you need custom API configurations.

With manual configuration, you can also create more complex AWIN Advertiser sources, such as sources that chain calls between the accounts, publishers, and transactions endpoints, or sources that pull data from newer endpoints that have not yet been added as templates.

API Method​

  1. To manually configure this source, select the Advanced tab at the top of the configuration screen.

  2. Select the API method that will be used for calls to the AWIN Advertiser API from the Method pulldown menu. The Awin Advertiser API exposes read endpoints under the GET method:

    • GET: For retrieving campaign reports, transactions, publishers, accounts, and transaction job status

API Endpoint URL​

  1. Enter the URL of the AWIN Advertiser API endpoint from which this source will fetch data in the Set API URL field. All Awin Advertiser endpoints are hosted under the base URL https://api.awin.com. For example, to list transactions, use {'https://api.awin.com/advertisers/{advertiserId}/transactions?startDate=...&endDate=...'}.

Ensure the API endpoint URL is correct and accessible with your current credentials. You can test the endpoint using the Test button after configuring the URL. The full list of Awin advertiser endpoints is documented at help.awin.com/apidocs.

Date/Time Macros (API URL)​

Optional

Optionally, the API URL can be customized using macros—all macros added to the API URL will be converted into values when Nexla executes the API call. Macros are dynamic placeholders that allow you to create flexible API endpoints that can adapt to different time periods or data requirements. This is particularly useful for the Awin transactions and report endpoints, which require explicit startDate and endDate parameters.

Macros are particularly useful for the Awin /transactions and /reports/* endpoints, which require startDate and endDate parameters that should advance with each scheduled ingestion run.

  1. To add a macro, type { at the appropriate position in the API URL (within the Set API URL field), and select the desired macro from the dropdown list.

    • {now} – The current datetime
    • {now-1} – The datetime one time unit before the current datetime
    • {now+1} – The datetime one time unit after the current datetime
    • custom – Datetime macros can reference any number of time units before or after the current datetime—for example, enter (now-4) to indicate the datetime four time units before the current datetime

  2. Select the format that will be applied to datetime macros from the Date Format for Date/Time Macro pulldown menu. For Awin's transaction endpoints, use the ISO datetime format yyyy-MM-dd'T'HH:mm:ss; for report endpoints, use yyyy-MM-dd.

  3. Select the datetime unit that will be used to perform mathematical operations in the included macro(s) from the Time Unit for Operations pulldown menu—for example, for the macro {now-1}, when Day is selected, {now-1} will be converted to the datetime one day before the current datetime.

Lookup-Based Macros (API URL)​

Optional

Column values from existing lookups can also be included as macros in the API URL. Lookup-based macros allow you to reference data from previously configured data sources or lookups, enabling dynamic API endpoints that can adapt based on existing data.

Lookup-based macros are useful for Awin scenarios such as iterating over a list of advertiser IDs or transaction IDs maintained in another Nexla source.

  1. To include a lookup column value macro, select the relevant lookup from the Add Lookups to Supported Macros pulldown menu.

  2. Type { at the appropriate position in the API URL, and select the lookup column-based macro from the dropdown list. Lookup-based macros are automatically populated into the macro list when a lookup is selected in the Add Lookups to Supported Macros pulldown menu.

Path to Data​

Optional

If only a subset of the data that will be returned by API endpoint is needed, you can designate the part(s) of the response that should be included in the Nexset(s) produced from this source by specifying the path to the relevant data within the response. This is particularly useful because Awin endpoints typically wrap result records in a top-level object (such as result, report, accounts, publishers, or jobs).

Path to Data is essential when API responses have nested structures. Without specifying the correct path, Nexla might not be able to properly parse and organize your data into usable records.

  • To specify which data should be treated as relevant in responses from this source, enter the path to the relevant data in the Set Path to Data in Response field.

    • For responses in JSON format enter the JSON path that points to the object or array that should be treated as relevant data. JSON paths use dot notation (e.g., $.report[*] to access the array of report rows returned by the campaign report endpoint).
    Path to Data Examples for Awin endpoints:
    • Campaign Performance: $.result[*]
    • Campaign Report / Publisher Report: $.report[*]
    • Accounts: $.accounts[*]
    • Publishers: $.publishers[*]
    • Transaction Jobs list: $.jobs[*]
    • List Transactions / Get Transactions by IDs: $[*]
Autogenerate Path Suggestions​

Nexla can also autogenerate data path suggestions based on the response from the API endpoint. These suggested paths can be used as-is or modified to exactly suit your needs.

  • To use this feature, click the Test button next to the Set API URL field to fetch a sample response from the API endpoint. Suggested data paths generated based on the content & format of the response will be displayed in the Suggestions box below the Set Path to Data in Response field.

  • Click on a suggestion to automatically populate the Set Path to Data in Response field with the corresponding path. The populated path can be modified directly within the field if further customization is needed.

    PathSuggestions.png

Metadata​

If metadata is included in the response but is located outside of the defined path to relevant data, you can configure Nexla to include this data as common metadata in each record. This is useful when you want to preserve important contextual information that applies to all records but isn't part of the main data array.

For example, several Awin endpoints return pagination metadata or aggregate totals alongside the result array. If you have set the Path to Data to the inner array, you can specify a metadata path so that these summary values are preserved on every record.

Metadata paths are particularly useful for preserving Awin response context such as total counts, request timestamps, or program-level summary statistics that apply to all records in the response.

  • To specify the location of metadata that should be included with each record, enter the path to the relevant metadata in the Path to Metadata in Response field.

    • For responses in JSON format, enter the JSON path to the object or array that contains the metadata.

Request Headers​

Optional

  • If Nexla should include any additional request headers in API calls to this source, enter the headers & corresponding values as comma-separated pairs in the Request Headers field (e.g., header1:value1,header2:value2). Additional headers are rarely required for Awin Advertiser endpoints, but can be used for API versioning or to pass content-type overrides if needed.

    You do not need to include the Awin Authorization header here—Nexla automatically applies the Authorization: Bearer ... header based on the credential configured above.

Rate Limiting​

Awin enforces a throttling limit of 20 API calls per minute per user account. When designing custom sources that fan out across many advertiser IDs, transaction IDs, or date windows, configure ingestion schedules to stay below this limit. Repeated 429 Too Many Requests responses indicate that the limit has been exceeded.

Endpoint Testing​

After configuring all settings for the selected endpoint, Nexla can retrieve a sample of the data that will be fetched according to the current configuration. This allows users to verify that the source is configured correctly before saving.

  • To test the current endpoint configuration, click the Test button to the right of the endpoint selection menu. Sample data will be fetched & displayed in the Endpoint Test Result panel on the right.

  • If the sample data is not as expected, review the selected endpoint and associated settings, and make any necessary adjustments. Then, click the Test button again, and check the sample data to ensure that the correct information is displayed.

Save & Activate the Source​

  1. Once all of the relevant steps in the above sections have been completed, click the Create button in the upper right corner of the screen to save and create the new AWIN Advertiser 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.