Skip to main content
Adtraction logo
  • Category: marketing
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 22
  • Triggers: 0
  • Slug: ADTRACTION
  • Version: 20261101_00

Tools

Slug: ADTRACTION_DOWNLOAD_PAYMENT_PDFDownload a partner payment specification as a PDF file.

Input Parameters

integer
required
Payment ID returned by List Payments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_GET_BALANCERetrieve pending, confirmed, invoiced, payable, and total Adtraction partner balances in one currency.

Input Parameters

string
required
ISO 4217 currency code for the balance amounts.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_GET_COMMISSION_SUMMARYSummarize Adtraction partner commission by commission type, payment status, or transaction status.

Input Parameters

string
ISO 3166-1 alpha-2 market code to filter commission.
string
required
Inclusive end date in ISO 8601 YYYY-MM-DD format.
string
required
ISO 4217 currency code for commission values.
string ("commission_type" | "payment_status" | "transaction_status")
required
Commission breakdown: commission_type, payment_status, or transaction_status.
string
required
Inclusive start date in ISO 8601 YYYY-MM-DD format.
integer
Channel ID to filter commission.
integer
Program ID to filter commission.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_GET_STATISTICSRetrieve aggregate Adtraction partner performance overall or grouped by channel, day, selected EPI dimensions, or program.

Input Parameters

string
required
ISO 3166-1 alpha-2 market code.
string
required
Inclusive end date in ISO 8601 YYYY-MM-DD format.
string
required
ISO 4217 currency code for monetary metrics.
string ("overall" | "channel" | "day" | "epi" | "program")
Breakdown for the statistics: overall, channel, day, EPI, or program.
string
required
Inclusive start date in ISO 8601 YYYY-MM-DD format.
integer
Partner channel ID to filter statistics.
integer
Program ID to filter statistics.
array
EPI dimensions to group by when group_by is epi. Values 1 through 5 map to EPI, EPI2, EPI3, EPI4, and EPI5.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_APPLICATIONSList the connected partner’s program applications, optionally filtered by program or channel.

Input Parameters

integer
Channel ID to filter applications.
integer
Program ID to filter applications.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_CHANNELSList approved partner channels or retrieve a specific channel by ID.

Input Parameters

integer
Approved channel ID to retrieve; omit to list all approved channels.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_CLICKSList Adtraction click events in a date range and specified currency, with optional attribution, program, channel, and market filters.

Input Parameters

string
Primary EPI attribution value to filter clicks.
string
Second EPI attribution value to filter clicks.
string
Third EPI attribution value to filter clicks.
string
Fourth EPI attribution value to filter clicks.
string
Fifth EPI attribution value to filter clicks.
string
Google Click ID to filter clicks.
string
GBRAID attribution value to filter clicks.
string
ISO 3166-1 alpha-2 market code to filter clicks.
string
WBRAID attribution value to filter clicks.
string
required
Inclusive ISO 8601 end timestamp with a numeric timezone offset.
string
required
ISO 4217 currency code for commission values.
string
required
Inclusive ISO 8601 start timestamp with a numeric timezone offset.
integer
Channel ID to filter clicks.
integer
Program ID to filter clicks.
boolean
Whether to return only clicks that generated commission.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_COMMISSION_TYPESList commission types for an Adtraction program, optionally using a channel for segment-specific rates.

Input Parameters

integer
Channel ID for segment-specific commission rates; omit for base rates.
integer
required
Program ID whose commission types to list.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_CURRENCIESList active currencies on the Adtraction platform.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_LATEST_TRANSACTIONSList a requested number of the connected partner’s latest approved or pending Adtraction transactions.

Input Parameters

integer
Number of recent transactions to return. Defaults to 10.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_MARKETSList Adtraction markets and their numeric IDs and ISO country codes for use in program discovery, category, and reporting tools.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_NEW_PROGRAMSList recently added partner programs in an Adtraction market.

Input Parameters

integer
required
Numeric market ID from List Markets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_OFFERSList coupons, vouchers, and offers available to the connected Adtraction partner, optionally filtered by market, program, or channel.

Input Parameters

string
ISO 3166-1 alpha-2 market code to filter offers.
integer
Channel ID used for channel-specific offers and tracking URLs.
integer
Program ID to filter offers.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_PAYMENTSList partner payments, optionally filtered by currency and payment ID. A payment ID requires a currency.

Input Parameters

string
ISO 4217 currency code to filter payments, for example EUR.
integer
Payment ID to retrieve; requires currency.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_PAYMENT_TRANSACTIONSList the transactions included in a specific partner payment.

Input Parameters

integer
required
Payment ID returned by List Payments.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_PRODUCT_FEEDSList product feed information for an advertiser program and partner channel. Download URLs are available when the channel is approved for the program.

Input Parameters

integer
required
Approved partner channel ID.
integer
required
Advertiser program ID.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_PROGRAM_CATEGORIESList program categories and program counts for an Adtraction market.

Input Parameters

integer
required
Numeric market ID from List Markets.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_TRACKING_ERRORSList tracking errors recorded in the connected Adtraction partner account during the last seven days, optionally filtered by channel or program.

Input Parameters

integer
Channel ID to filter tracking errors.
integer
Program ID to filter tracking errors.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_LIST_TRANSACTIONSList Adtraction partner transactions in a date range with status, attribution, payment, market, currency, program, and channel filters.

Input Parameters

string
Primary EPI attribution value to filter transactions.
string
ISO 3166-1 alpha-2 market code to filter transactions.
string
required
Inclusive ISO 8601 end timestamp with a numeric timezone offset.
string
ISO 4217 currency code to filter transactions.
string
required
Inclusive ISO 8601 start timestamp with a numeric timezone offset.
string
Provider transaction unique ID to retrieve.
integer
Channel ID to filter transactions.
integer
Program ID to filter transactions.
string
Only include transactions updated since this ISO 8601 timestamp with a numeric timezone offset.
integer ("1" | "2" | "3" | "4")
Payment status: 1 not invoiced, 2 invoiced to advertiser, 3 ready for payment, or 4 paid to partner.
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

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_SEARCH_PRODUCTSSearch 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

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

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: ADTRACTION_SEARCH_PROGRAMSFind Adtraction partner programs in a market, optionally filtered by program, channel, approval status, and lifecycle status.

Input Parameters

string
required
ISO 3166-1 alpha-2 market code.
integer ("0" | "3")
Program lifecycle status: 0 live or 3 closing.
integer
Channel ID used to return channel-specific approval information.
integer
Program ID to retrieve.
integer ("0" | "1" | "2")
Approval status: 0 rejected, 1 approved, or 2 pending.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not