---
canonical_url: "https://docs.composio.dev/toolkits/adtraction"
markdown_url: "https://docs.composio.dev/toolkits/adtraction.md"
product: "platform"
version: null
last_updated: null
---

# Adtraction

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

- **Category:** marketing
- **Auth:** API_KEY
- **Composio-managed OAuth available?** N/A
- **Tools:** 22
- **Triggers:** 0
- **Slug:** `ADTRACTION`
- **Version:** 00000000_00

## Tools

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epi` | string | No | Primary EPI value for custom attribution in Adtraction reports. |
| `url` | string | No | Optional absolute advertiser-domain HTTP(S) destination URL. Omit it to use the program's default destination. |
| `epi2` | string | No | Second optional EPI attribution value. |
| `epi3` | string | No | Third optional EPI attribution value. |
| `epi4` | string | No | Fourth optional EPI attribution value. |
| `epi5` | string | No | Fifth optional EPI attribution value. |
| `channel_id` | integer | Yes | Approved partner channel ID to attribute visits and conversions to. |
| `program_id` | integer | Yes | Advertiser program ID for the destination and tracking relationship. |
| `short_link` | boolean | No | Whether Adtraction should return a shortened tracking URL. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Download Payment PDF

**Slug:** `ADTRACTION_DOWNLOAD_PAYMENT_PDF`

Download a partner payment specification as a PDF file.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payment_id` | integer | Yes | Payment ID returned by List Payments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Partner Balance

**Slug:** `ADTRACTION_GET_BALANCE`

Retrieve pending, confirmed, invoiced, payable, and total Adtraction partner balances in one currency.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `currency` | string | Yes | ISO 4217 currency code for the balance amounts. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### Get Commission Summary

**Slug:** `ADTRACTION_GET_COMMISSION_SUMMARY`

Summarize Adtraction partner commission by commission type, payment status, or transaction status.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `market` | string | No | ISO 3166-1 alpha-2 market code to filter commission. |
| `to_date` | string | Yes | Inclusive end date in ISO 8601 YYYY-MM-DD format. |
| `currency` | string | Yes | ISO 4217 currency code for commission values. |
| `breakdown` | string ("commission_type" | "payment_status" | "transaction_status") | Yes | Commission breakdown: commission_type, payment_status, or transaction_status. |
| `from_date` | string | Yes | Inclusive start date in ISO 8601 YYYY-MM-DD format. |
| `channel_id` | integer | No | Channel ID to filter commission. |
| `program_id` | integer | No | Program ID to filter commission. |
| `transaction_status` | integer ("1" | "2" | "3" | "4" | "5") | No | Required for commission_type: 1 approved, 2 pending, 3 approved and pending, 4 open claims, or 5 rejected. Omit for other breakdowns. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `market` | string | Yes | ISO 3166-1 alpha-2 market code. |
| `to_date` | string | Yes | Inclusive end date in ISO 8601 YYYY-MM-DD format. |
| `currency` | string | Yes | ISO 4217 currency code for monetary metrics. |
| `group_by` | string ("overall" | "channel" | "day" | "epi" | "program") | No | Breakdown for the statistics: overall, channel, day, EPI, or program. |
| `from_date` | string | Yes | Inclusive start date in ISO 8601 YYYY-MM-DD format. |
| `channel_id` | integer | No | Partner channel ID to filter statistics. |
| `program_id` | integer | No | Program ID to filter statistics. |
| `epi_dimensions` | array | No | 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") | Yes | Transactions to include: 1 approved, 2 pending, 3 approved and pending, 4 open claims, or 5 rejected. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Program Applications

**Slug:** `ADTRACTION_LIST_APPLICATIONS`

List the connected partner's program applications, optionally filtered by program or channel.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | integer | No | Channel ID to filter applications. |
| `program_id` | integer | No | Program ID to filter applications. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Partner Channels

**Slug:** `ADTRACTION_LIST_CHANNELS`

List approved partner channels or retrieve a specific channel by ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | integer | No | Approved channel ID to retrieve; omit to list all approved channels. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Clicks

**Slug:** `ADTRACTION_LIST_CLICKS`

List Adtraction click events in a date range with attribution, program, channel, market, and currency filters.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epi` | string | No | Primary EPI attribution value to filter clicks. |
| `epi2` | string | No | Second EPI attribution value to filter clicks. |
| `epi3` | string | No | Third EPI attribution value to filter clicks. |
| `epi4` | string | No | Fourth EPI attribution value to filter clicks. |
| `epi5` | string | No | Fifth EPI attribution value to filter clicks. |
| `gclid` | string | No | Google Click ID to filter clicks. |
| `gbraid` | string | No | GBRAID attribution value to filter clicks. |
| `market` | string | No | ISO 3166-1 alpha-2 market code to filter clicks. |
| `wbraid` | string | No | WBRAID attribution value to filter clicks. |
| `to_date` | string | Yes | Inclusive ISO 8601 end timestamp with a numeric timezone offset. |
| `currency` | string | Yes | ISO 4217 currency code for commission values. |
| `from_date` | string | Yes | Inclusive ISO 8601 start timestamp with a numeric timezone offset. |
| `channel_id` | integer | No | Channel ID to filter clicks. |
| `program_id` | integer | No | Program ID to filter clicks. |
| `commission_only` | boolean | No | Whether to return only clicks that generated commission. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | integer | No | Channel ID for segment-specific commission rates; omit for base rates. |
| `program_id` | integer | Yes | Program ID whose commission types to list. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Currencies

**Slug:** `ADTRACTION_LIST_CURRENCIES`

List currencies available to the connected Adtraction partner account.

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Latest Transactions

**Slug:** `ADTRACTION_LIST_LATEST_TRANSACTIONS`

Return a requested number of the connected partner's latest Adtraction transactions.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `number` | integer | No | Number of recent transactions to return. Defaults to 10. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List New Programs

**Slug:** `ADTRACTION_LIST_NEW_PROGRAMS`

List recently added partner programs in an Adtraction market.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `market_id` | integer | Yes | Numeric market ID from List Markets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `market` | string | No | ISO 3166-1 alpha-2 market code to filter offers. |
| `channel_id` | integer | No | Channel ID used for channel-specific offers and tracking URLs. |
| `program_id` | integer | No | Program ID to filter offers. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payments

**Slug:** `ADTRACTION_LIST_PAYMENTS`

List partner payments, optionally filtered by currency and payment ID.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `currency` | string | No | ISO 4217 currency code to filter payments, for example EUR. |
| `payment_id` | integer | No | Payment ID to retrieve; requires currency. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Payment Transactions

**Slug:** `ADTRACTION_LIST_PAYMENT_TRANSACTIONS`

List the transactions included in a specific partner payment.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `payment_id` | integer | Yes | Payment ID returned by List Payments. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Product Feeds

**Slug:** `ADTRACTION_LIST_PRODUCT_FEEDS`

List product feeds available for an advertiser program and approved partner channel.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | integer | Yes | Approved partner channel ID. |
| `program_id` | integer | Yes | Advertiser program ID. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### List Program Categories

**Slug:** `ADTRACTION_LIST_PROGRAM_CATEGORIES`

List program categories and program counts for an Adtraction market.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `market_id` | integer | Yes | Numeric market ID from List Markets. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `channel_id` | integer | No | Channel ID to filter tracking errors. |
| `program_id` | integer | No | Program ID to filter tracking errors. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `epi` | string | No | Primary EPI attribution value to filter transactions. |
| `market` | string | No | ISO 3166-1 alpha-2 market code to filter transactions. |
| `to_date` | string | Yes | Inclusive ISO 8601 end timestamp with a numeric timezone offset. |
| `currency` | string | No | ISO 4217 currency code to filter transactions. |
| `from_date` | string | Yes | Inclusive ISO 8601 start timestamp with a numeric timezone offset. |
| `unique_id` | string | No | Provider transaction unique ID to retrieve. |
| `channel_id` | integer | No | Channel ID to filter transactions. |
| `program_id` | integer | No | Program ID to filter transactions. |
| `last_updated` | string | No | Only include transactions updated since this ISO 8601 timestamp with a numeric timezone offset. |
| `payment_status` | integer ("1" | "2" | "3" | "4") | No | 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") | Yes | Transaction status: 0 all, 1 approved, 2 pending, 3 approved and pending, 4 open claims, or 5 rejected. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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.

#### Input Parameters

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `sort` | string | No | Comma-separated sort expression using productPrice, programId, inStock, manufacturerArticleNumber, or ean, optionally followed by :asc or :desc. |
| `market` | string | No | ISO 3166-1 alpha-2 market code to filter products. |
| `keyword` | string | Yes | Product query. Supports AND, OR, exclusions, quoted phrases, wildcard suffixes, and field-qualified search. |
| `currency` | string | No | ISO 4217 currency code to filter products. |
| `in_stock` | boolean | No | Whether to return only in-stock or only out-of-stock products. |
| `max_price` | number | No | Maximum product price in the selected or product currency. |
| `min_price` | number | No | Minimum product price in the selected or product currency. |
| `page_size` | integer | No | Products to request per page. No provider maximum is documented; keep requests modest. |
| `next_cursor` | string | No | Continuation cursor from a previous Search Products response. Pass it unchanged; omit it for page 0. |
| `program_ids` | array | No | Program IDs to include in the search. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |

### 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

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `market` | string | Yes | ISO 3166-1 alpha-2 market code. |
| `status` | integer ("0" | "3") | No | Program lifecycle status: 0 live or 3 closing. |
| `channel_id` | integer | No | Channel ID used to return channel-specific approval information. |
| `program_id` | integer | No | Program ID to retrieve. |
| `approval_status` | integer ("0" | "1" | "2") | No | Approval status: 0 rejected, 1 approved, or 2 pending. |

#### Output

| Parameter | Type | Required | Description |
|-----------|------|----------|-------------|
| `data` | string | Yes | Data from the action execution |
| `error` | string | No | Error if any occurred during the execution of the action |
| `successful` | boolean | Yes | Whether or not the action execution was successful or not |