This article lists every action available in the Trackdesk Public API, grouped by area, with a one-line summary of what each endpoint does. Use it to quickly check whether something can be done via the API. For request fields, examples and responses, click the endpoint to open it in the full API reference.
The list covers the full API, used by program owners and their team. Affiliates and advertisers can call a smaller set of these endpoints with their own token.
Before you start
Base URL:
https://TENANT_ID.trackdesk.com. ReplaceTENANT_IDwith your Tenant ID, which is your program's subdomain.Authentication: send your personal access token in the
X-Api-Keyheader (see Personal Tokens and API Access), or use an OAuth2 access token (see OAuth2 authorization below).Full reference: developers.trackdesk.com, also available as an OpenAPI specification.
Affiliate and advertiser references: the endpoints an affiliate's or advertiser's own token can call are listed in the Affiliate API (OpenAPI) and the Advertiser API (OpenAPI).
Your program's reference:
https://TENANT_ID.trackdesk.com/developershas your Tenant ID filled in, and its Test Request calls use your signed-in session, so you can try endpoints without a token.Limits: see API Rate Limiting.
AI assistants: the same actions are available through the Trackdesk MCP Server.
Clicks and tracking links
Create click: Creates a new click on the server side, without a visitor loading the click tracking script. You send the link ID, affiliate source ID, IP address and user agent (plus optional geo data, referrer, AffS1 to AffS5 and ad click IDs). The response contains the click's CID, which you then use when creating conversions.
Build tracking link: Generates a tracking link for a given affiliate and offer (direct, system redirect or Google-certified redirect), optionally with AffS1 to AffS5 parameters appended.
List conversion types available for a CID: Returns the conversion types that are available for a given Click ID (CID).
Conversions
Create conversion: Creates a new conversion. It can be attributed by CID, External CID, external client ID or coupon codes, and can carry the conversion type, amount, currency, status, External ID (for deduplication), customer ID and custom parameters.
Update conversion: Updates selected properties of an existing conversion.
Set conversion status: Changes the status of an existing conversion.
Change conversion status by External ID: Updates the status of conversions matched by their External ID.
Redeem coupon: Looks up the affiliate linked to any of the provided coupon codes and returns a CID you can use to attribute a conversion to that affiliate.
Set External CID: Adds an external click identifier to a click.
Clients and client metrics
A client is your customer (in iGaming programs, a player). See Registering players and recording movements via the API for a worked example.
Create client: Creates a client with your own external ID and links it to a click (CID).
Update client: Updates the editable fields of a client. Fields you don't send stay unchanged.
Create client metric movement: Records metric values for a client identified by its external client ID. Repeated requests with the same request ID are ignored.
List client metric movements: Returns a paginated list of metric movements matching your filters.
List client metrics: Returns all integer and decimal metrics defined for the advertiser.
Update client metric name: Changes the display name of a client metric.
Update client metric visibility: Controls whether the metric is visible in the UI.
Affiliates
List affiliates: Lists the affiliates in your program, with filters (for example, by email).
Create affiliate: Creates a new affiliate in your program.
Get affiliate details: Returns detailed information about a specific affiliate.
Set affiliate status: Changes the status of an affiliate.
Set affiliate billing status: Includes an affiliate in, or excludes them from, open balances and settlements. Tracking, conversions and commissions are not affected. See Affiliate Billing Status.
Set affiliate tier: Assigns a tier to the selected affiliates.
Delete affiliate: Deletes an affiliate from your program.
Get affiliate registration data: Returns the data the affiliate filled in during registration.
Create affiliate registration data: Creates registration data for an affiliate.
Create account note: Adds a note to an affiliate account.
List account notes: Lists the notes on an affiliate account, ordered by creation time.
Delete account note: Removes a note.
Affiliate tiers
List affiliate tiers: Returns active affiliate tiers and their payout rates.
Get affiliate tier: Returns a specific tier with its payout rates.
Create affiliate tier: Creates a new affiliate tier.
Update affiliate tier: Updates the values of a tier.
Delete affiliate tier: Deletes a tier. The default tier, and tiers that still have affiliates assigned, can't be deleted.
Affiliate bonuses
Bonuses are one-off amounts added to, or deducted from, an affiliate's open balance and paid out with their next settlement. See Affiliate Bonuses.
Create affiliate bonus: Creates a bonus for an affiliate in one of the currencies configured in your program.
List affiliate bonuses: Lists bonuses, optionally filtered by affiliate, settlement or creation date.
Get affiliate bonus: Returns a bonus by its ID.
Update affiliate bonus: Replaces the editable fields of a bonus that hasn't been settled yet. The affiliate can't be changed.
Delete affiliate bonus: Deletes a bonus that hasn't been settled yet.
Offers
Offer settings and pricing
Create offer: Creates an offer with its configuration, pricing and landing pages and publishes it, either immediately or at a scheduled time.
List offers: Lists offers matching your filters, each with its pricing and landing pages.
Get offer: Returns an offer with its pricing and landing pages.
Update offer: Updates the offer's general settings (name, visibility, targeting, tags, description and so on) and its status. Pricing and landing pages have their own endpoints.
Update offer pricing: Updates the offer's conversion type settings and targeting groups. This is also where you set a payout for a single affiliate: add it under
sourceCostsin a currency group, using the affiliate's source ID, and it overrides their tier payout for that offer. Send the complete pricing, not only the part you changed.
Affiliate access to offers
Set affiliate access to offer: Allows or forbids one or more affiliates on an offer, for example to grant or revoke access to a private offer.
List affiliate assignments to offer: Lists the affiliates assigned to an offer with their access level, assignment time and any pending application.
Landing pages
Create landing pages: Creates one or more landing pages for an offer, each with a direct or redirect tracking link.
List landing pages: Lists all landing pages of an offer.
Update landing page: Updates an existing landing page.
Prioritize landing pages: Sets the priority order that decides which redirect landing page a visitor is sent to when several match their location, language, device and operating system.
Creatives
List offer creatives: Lists the promotional creatives of an offer.
Create offer creative: Adds a content-based creative (HTML, text link, external video or post) to an offer.
Upload offer creative: Uploads a file-based creative (image banner, video or ZIP archive) to an offer, or replaces the file of an existing creative.
Update offer creative: Updates a creative's content, name, note or visibility.
Delete offer creative: Removes a creative from an offer.
Offer caps
Create offer cap: Creates a daily, weekly or monthly conversion cap for an offer (by count or revenue), optionally split by source, with a fallback redirect once the cap is reached.
List offer caps: Returns an offer's caps with their limits, current utilization and source-specific overrides.
Add offer cap source limit: Sets a per-affiliate limit that overrides the cap's default source limit.
Remove offer cap source limit: Removes a per-affiliate override, reverting to the cap's default source limit.
Delete offer cap: Permanently removes a cap from an offer.
Coupons
Create coupon: Creates a new coupon.
List coupons: Returns all existing coupons.
Delete coupon: Deletes a coupon.
Affiliate billing and payouts
For the full payout flow, see Handling Affiliate Billing via API.
Billing details and payment methods
Set billing details: Fills in the billing details of an affiliate account.
List supported payment method types: Returns all payment method types enabled in the system and their supported currencies.
Create payment method: Creates a new payment method for an affiliate account.
Update payment method: Updates the data of a payment method.
Balances and settlements
List open balances: Lists affiliates' open balances with conversion and commission amounts by status.
Get balances for affiliate: Returns an affiliate's open, on-hold and settled amounts.
Create settlement: Creates a settlement for selected affiliates, covering balances up to a given date.
List settlements: Lists settlements in a selected timeframe.
Get settlement: Returns the details of a settlement.
Delete settlement: Deletes an entire settlement, which may include several affiliates.
List affiliate settlements: Lists settlements for one affiliate or all affiliates.
Update affiliate settlement status: Updates the status of a single affiliate settlement. Not available for Tipalti settlements, and the Error status can't be set manually.
Delete affiliate settlement: Deletes one affiliate's part of a settlement without deleting the whole settlement.
Tipalti payouts
List payable affiliate settlements: Lists the unpaid affiliate settlements in a settlement that can be paid via Tipalti.
Create Tipalti payment batch: Sends a payment batch for a settlement to Tipalti. Only unpaid affiliate settlements with a Tipalti payment method and a payable Tipalti payee are included.
Check Tipalti payment batch status: Checks a payment batch in Tipalti and refreshes the settlement's payment data. Only needed when you want to sync manually.
Advertisers
Available for networks. In the API, advertisers are called revenue origins.
Create advertiser: Creates a new advertiser.
List advertisers: Lists the advertisers in your system.
Update advertiser: Updates an advertiser.
Get advertiser open balances: Returns the current open balance of each advertiser.
Create advertiser settlement: Generates a settlement for a specific advertiser.
List advertiser settlements: Lists existing advertiser settlements.
Get advertiser settlement: Returns the details of an advertiser settlement.
Delete advertiser settlement: Deletes an advertiser settlement.
Reports
Click report: Returns information about registered clicks.
Conversion report: Returns data about tracked conversions.
Daily overview report: Returns performance per day: clicks, conversions, revenue, payouts and more.
General overview report: Returns performance data aggregated at the level you choose, such as day, country, affiliate or offer.
Affiliate overview report (deprecated): Performance per affiliate. Use the General overview report instead.
Country overview report (deprecated): Performance per country. Use the General overview report instead.
Offer overview report (deprecated): Performance per offer. Use the General overview report instead.
Tags
List tags: Lists all tags.
Get tag: Returns the details of a tag.
Create tag: Creates a new tag.
Delete tag: Deletes a tag.
Webhooks
List webhooks: Returns the currently active webhooks.
Create webhook: Creates a new webhook.
Test webhook: Triggers a webhook so you can check that it works and see the data it sends.
Delete webhook: Deletes a webhook.
Program settings
Get default timezone: Returns the default timezone set in your program's general settings.
OAuth2 authorization
Instead of a personal access token, you can authenticate with an OAuth2 access token. Create a client in Settings → Integrations → OAuth2. Use the client_credentials grant for machine-to-machine access, or authorization_code with PKCE when a user approves the access at https://TENANT_ID.trackdesk.com/oauth/authorize. Access tokens expire after 1 hour, and refresh tokens are replaced with a new one on every use.
Create or refresh access token: Issues an access token for the
client_credentials,authorization_codeorrefresh_tokengrant. Authorization codes need the original redirect URI and the PKCE code verifier.Revoke OAuth grant: Revokes an access or refresh token, together with the whole user authorization behind it. Tokens issued through
client_credentialscan't be revoked one by one; delete the client instead.Check credential: Checks whether an access token or API key is valid.
Register OAuth client: Registers a public client automatically (dynamic client registration), so an app can get a client ID without anyone entering one by hand. The client can't do anything until a user approves it on the consent screen, and registrations nobody approves are deleted within two hours.