> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Adtraction

> Adtraction is an affiliate marketing platform for managing partner programs, tracking links, transactions, commissions, statistics, and payments.

![Adtraction logo](https://mintcdn.com/composio-preview/qzegrvAapILigeDI/images/toolkits/adtraction.svg?fit=max\&auto=format\&n=qzegrvAapILigeDI\&q=85\&s=b30cb9a614d0871d5e7cdbc73b59deb9)

* **Category:** marketing
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 22
* **Triggers:** 0
* **Slug:** `ADTRACTION`
* **Version:** 20261101\_00

## Tools

> [accordion] Create Tracking Link
>
> **Slug:** `ADTRACTION_CREATE_TRACKING_LINK`
>
> Generate an externally usable Adtraction affiliate tracking URL for an approved channel and advertiser program. The returned link attributes traffic and conversions using the supplied EPI values; generating it does not change channel, program, or account settings.
>
> #### Input Parameters
>
> **epi** `string`
>
> Primary EPI value for custom attribution in Adtraction reports.
>
> **url** `string`
>
> Optional absolute advertiser-domain HTTP(S) destination URL. Omit it to use the program's default destination.
>
> **epi2** `string`
>
> Second optional EPI attribution value.
>
> **epi3** `string`
>
> Third optional EPI attribution value.
>
> **epi4** `string`
>
> Fourth optional EPI attribution value.
>
> **epi5** `string`
>
> Fifth optional EPI attribution value.
>
> **channel\_id** `integer` *required*
>
> Approved partner channel ID to attribute visits and conversions to.
>
> **program\_id** `integer` *required*
>
> Advertiser program ID for the destination and tracking relationship.
>
> **short\_link** `boolean`
>
> Whether Adtraction should return a shortened tracking URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Download Payment PDF
>
> **Slug:** `ADTRACTION_DOWNLOAD_PAYMENT_PDF`
>
> Download a partner payment specification as a PDF file.
>
> #### Input Parameters
>
> **payment\_id** `integer` *required*
>
> Payment ID returned by List Payments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Partner Balance
>
> **Slug:** `ADTRACTION_GET_BALANCE`
>
> Retrieve pending, confirmed, invoiced, payable, and total Adtraction partner balances in one currency.
>
> #### Input Parameters
>
> **currency** `string` *required*
>
> ISO 4217 currency code for the balance amounts.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Commission Summary
>
> **Slug:** `ADTRACTION_GET_COMMISSION_SUMMARY`
>
> Summarize Adtraction partner commission by commission type, payment status, or transaction status.
>
> #### Input Parameters
>
> **market** `string`
>
> ISO 3166-1 alpha-2 market code to filter commission.
>
> **to\_date** `string` *required*
>
> Inclusive end date in ISO 8601 YYYY-MM-DD format.
>
> **currency** `string` *required*
>
> ISO 4217 currency code for commission values.
>
> **breakdown** `string ("commission_type" | "payment_status" | "transaction_status")` *required*
>
> Commission breakdown: commission\_type, payment\_status, or transaction\_status.
>
> **from\_date** `string` *required*
>
> Inclusive start date in ISO 8601 YYYY-MM-DD format.
>
> **channel\_id** `integer`
>
> Channel ID to filter commission.
>
> **program\_id** `integer`
>
> Program ID to filter commission.
>
> **transaction\_status** `integer ("1" | "2" | "3" | "4" | "5")`
>
> Required for commission\_type: 1 approved, 2 pending, 3 approved and pending, 4 open claims, or 5 rejected. Omit for other breakdowns.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Partner Statistics
>
> **Slug:** `ADTRACTION_GET_STATISTICS`
>
> Retrieve aggregate Adtraction partner performance overall or grouped by channel, day, selected EPI dimensions, or program.
>
> #### Input Parameters
>
> **market** `string` *required*
>
> ISO 3166-1 alpha-2 market code.
>
> **to\_date** `string` *required*
>
> Inclusive end date in ISO 8601 YYYY-MM-DD format.
>
> **currency** `string` *required*
>
> ISO 4217 currency code for monetary metrics.
>
> **group\_by** `string ("overall" | "channel" | "day" | "epi" | "program")`
>
> Breakdown for the statistics: overall, channel, day, EPI, or program.
>
> **from\_date** `string` *required*
>
> Inclusive start date in ISO 8601 YYYY-MM-DD format.
>
> **channel\_id** `integer`
>
> Partner channel ID to filter statistics.
>
> **program\_id** `integer`
>
> Program ID to filter statistics.
>
> **epi\_dimensions** `array`
>
> EPI dimensions to group by when group\_by is epi. Values 1 through 5 map to EPI, EPI2, EPI3, EPI4, and EPI5.
>
> **transaction\_status** `integer ("1" | "2" | "3" | "4" | "5")` *required*
>
> Transactions to include: 1 approved, 2 pending, 3 approved and pending, 4 open claims, or 5 rejected.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Program Applications
>
> **Slug:** `ADTRACTION_LIST_APPLICATIONS`
>
> List the connected partner's program applications, optionally filtered by program or channel.
>
> #### Input Parameters
>
> **channel\_id** `integer`
>
> Channel ID to filter applications.
>
> **program\_id** `integer`
>
> Program ID to filter applications.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Partner Channels
>
> **Slug:** `ADTRACTION_LIST_CHANNELS`
>
> List approved partner channels or retrieve a specific channel by ID.
>
> #### Input Parameters
>
> **channel\_id** `integer`
>
> Approved channel ID to retrieve; omit to list all approved channels.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Clicks
>
> **Slug:** `ADTRACTION_LIST_CLICKS`
>
> List Adtraction click events in a date range and specified currency, with optional attribution, program, channel, and market filters.
>
> #### Input Parameters
>
> **epi** `string`
>
> Primary EPI attribution value to filter clicks.
>
> **epi2** `string`
>
> Second EPI attribution value to filter clicks.
>
> **epi3** `string`
>
> Third EPI attribution value to filter clicks.
>
> **epi4** `string`
>
> Fourth EPI attribution value to filter clicks.
>
> **epi5** `string`
>
> Fifth EPI attribution value to filter clicks.
>
> **gclid** `string`
>
> Google Click ID to filter clicks.
>
> **gbraid** `string`
>
> GBRAID attribution value to filter clicks.
>
> **market** `string`
>
> ISO 3166-1 alpha-2 market code to filter clicks.
>
> **wbraid** `string`
>
> WBRAID attribution value to filter clicks.
>
> **to\_date** `string` *required*
>
> Inclusive ISO 8601 end timestamp with a numeric timezone offset.
>
> **currency** `string` *required*
>
> ISO 4217 currency code for commission values.
>
> **from\_date** `string` *required*
>
> Inclusive ISO 8601 start timestamp with a numeric timezone offset.
>
> **channel\_id** `integer`
>
> Channel ID to filter clicks.
>
> **program\_id** `integer`
>
> Program ID to filter clicks.
>
> **commission\_only** `boolean`
>
> Whether to return only clicks that generated commission.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Program Commission Types
>
> **Slug:** `ADTRACTION_LIST_COMMISSION_TYPES`
>
> List commission types for an Adtraction program, optionally using a channel for segment-specific rates.
>
> #### Input Parameters
>
> **channel\_id** `integer`
>
> Channel ID for segment-specific commission rates; omit for base rates.
>
> **program\_id** `integer` *required*
>
> Program ID whose commission types to list.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Currencies
>
> **Slug:** `ADTRACTION_LIST_CURRENCIES`
>
> List active currencies on the Adtraction platform.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Latest Transactions
>
> **Slug:** `ADTRACTION_LIST_LATEST_TRANSACTIONS`
>
> List a requested number of the connected partner's latest approved or pending Adtraction transactions.
>
> #### Input Parameters
>
> **number** `integer`
>
> Number of recent transactions to return. Defaults to 10.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Markets
>
> **Slug:** `ADTRACTION_LIST_MARKETS`
>
> List Adtraction markets and their numeric IDs and ISO country codes for use in program discovery, category, and reporting tools.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List New Programs
>
> **Slug:** `ADTRACTION_LIST_NEW_PROGRAMS`
>
> List recently added partner programs in an Adtraction market.
>
> #### Input Parameters
>
> **market\_id** `integer` *required*
>
> Numeric market ID from List Markets.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Offers
>
> **Slug:** `ADTRACTION_LIST_OFFERS`
>
> List coupons, vouchers, and offers available to the connected Adtraction partner, optionally filtered by market, program, or channel.
>
> #### Input Parameters
>
> **market** `string`
>
> ISO 3166-1 alpha-2 market code to filter offers.
>
> **channel\_id** `integer`
>
> Channel ID used for channel-specific offers and tracking URLs.
>
> **program\_id** `integer`
>
> Program ID to filter offers.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payments
>
> **Slug:** `ADTRACTION_LIST_PAYMENTS`
>
> List partner payments, optionally filtered by currency and payment ID. A payment ID requires a currency.
>
> #### Input Parameters
>
> **currency** `string`
>
> ISO 4217 currency code to filter payments, for example EUR.
>
> **payment\_id** `integer`
>
> Payment ID to retrieve; requires currency.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Payment Transactions
>
> **Slug:** `ADTRACTION_LIST_PAYMENT_TRANSACTIONS`
>
> List the transactions included in a specific partner payment.
>
> #### Input Parameters
>
> **payment\_id** `integer` *required*
>
> Payment ID returned by List Payments.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Product Feeds
>
> **Slug:** `ADTRACTION_LIST_PRODUCT_FEEDS`
>
> List product feed information for an advertiser program and partner channel. Download URLs are available when the channel is approved for the program.
>
> #### Input Parameters
>
> **channel\_id** `integer` *required*
>
> Approved partner channel ID.
>
> **program\_id** `integer` *required*
>
> Advertiser program ID.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Program Categories
>
> **Slug:** `ADTRACTION_LIST_PROGRAM_CATEGORIES`
>
> List program categories and program counts for an Adtraction market.
>
> #### Input Parameters
>
> **market\_id** `integer` *required*
>
> Numeric market ID from List Markets.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Tracking Errors
>
> **Slug:** `ADTRACTION_LIST_TRACKING_ERRORS`
>
> List tracking errors recorded in the connected Adtraction partner account during the last seven days, optionally filtered by channel or program.
>
> #### Input Parameters
>
> **channel\_id** `integer`
>
> Channel ID to filter tracking errors.
>
> **program\_id** `integer`
>
> Program ID to filter tracking errors.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] List Transactions
>
> **Slug:** `ADTRACTION_LIST_TRANSACTIONS`
>
> List Adtraction partner transactions in a date range with status, attribution, payment, market, currency, program, and channel filters.
>
> #### Input Parameters
>
> **epi** `string`
>
> Primary EPI attribution value to filter transactions.
>
> **market** `string`
>
> ISO 3166-1 alpha-2 market code to filter transactions.
>
> **to\_date** `string` *required*
>
> Inclusive ISO 8601 end timestamp with a numeric timezone offset.
>
> **currency** `string`
>
> ISO 4217 currency code to filter transactions.
>
> **from\_date** `string` *required*
>
> Inclusive ISO 8601 start timestamp with a numeric timezone offset.
>
> **unique\_id** `string`
>
> Provider transaction unique ID to retrieve.
>
> **channel\_id** `integer`
>
> Channel ID to filter transactions.
>
> **program\_id** `integer`
>
> Program ID to filter transactions.
>
> **last\_updated** `string`
>
> Only include transactions updated since this ISO 8601 timestamp with a numeric timezone offset.
>
> **payment\_status** `integer ("1" | "2" | "3" | "4")`
>
> Payment status: 1 not invoiced, 2 invoiced to advertiser, 3 ready for payment, or 4 paid to partner.
>
> **transaction\_status** `integer ("0" | "1" | "2" | "3" | "4" | "5")` *required*
>
> Transaction status: 0 all, 1 approved, 2 pending, 3 approved and pending, 4 open claims, or 5 rejected.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Products
>
> **Slug:** `ADTRACTION_SEARCH_PRODUCTS`
>
> Search the Adtraction partner product database using text, program, market, currency, stock, price, and sort filters. Returns one page at a time; a continuation cursor depends on pagination headers being present.
>
> #### Input Parameters
>
> **sort** `string`
>
> Comma-separated sort expression using productPrice, programId, inStock, manufacturerArticleNumber, or ean, optionally followed by :asc or :desc.
>
> **market** `string`
>
> ISO 3166-1 alpha-2 market code to filter products.
>
> **keyword** `string` *required*
>
> Product query. Supports AND, OR, exclusions, quoted phrases, wildcard suffixes, and field-qualified search.
>
> **currency** `string`
>
> ISO 4217 currency code to filter products.
>
> **in\_stock** `boolean`
>
> Whether to return only in-stock or only out-of-stock products.
>
> **max\_price** `number`
>
> Maximum product price in the selected or product currency.
>
> **min\_price** `number`
>
> Minimum product price in the selected or product currency.
>
> **page\_size** `integer`
>
> Products to request per page. No provider maximum is documented; keep requests modest.
>
> **next\_cursor** `string`
>
> Continuation cursor from a previous Search Products response. Pass it unchanged; omit it for page 0.
>
> **program\_ids** `array`
>
> Program IDs to include in the search.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search Programs
>
> **Slug:** `ADTRACTION_SEARCH_PROGRAMS`
>
> Find Adtraction partner programs in a market, optionally filtered by program, channel, approval status, and lifecycle status.
>
> #### Input Parameters
>
> **market** `string` *required*
>
> ISO 3166-1 alpha-2 market code.
>
> **status** `integer ("0" | "3")`
>
> Program lifecycle status: 0 live or 3 closing.
>
> **channel\_id** `integer`
>
> Channel ID used to return channel-specific approval information.
>
> **program\_id** `integer`
>
> Program ID to retrieve.
>
> **approval\_status** `integer ("0" | "1" | "2")`
>
> Approval status: 0 rejected, 1 approved, or 2 pending.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
