Skip to main content

Enabling and managing the API Data Feed in Settings

Written by Joe Hatch

Where to find it

  1. Click your initials in the top right corner

  2. Choose Settings

  3. Scroll to the API DATA FEED section

  4. Click Manage API data feed

If your plan does not include the API Data Feed

The button opens Request API Data Feed Access. Pick the option that best describes what you want to do with the data — export to a visualisation tool, to another stats aggregator, into your organisation's systems, or into your own database — or choose Other and describe it in your own words (up to 300 characters). Click Submit and our team will get back to you.

The Data Feed Management screen

API Data Feed Status — a single toggle, Inactive / Active.

While it is set to Inactive the whole screen is greyed out and the feed answers no queries. Switch it to Active to use the feed. You can switch it back off at any time; nothing is deleted, and turning it on again restores access with the same key.

API key — a read-only field showing your current key.

  • If you have never created one, click Generate new API key and the key appears in the field.

  • If you already have one, Generate new API key asks you to confirm first: *"Generating a new API key will immediately revoke the access of any applications currently using the existing API key. Do you wish to proceed?"*

That is exactly what happens — the moment you confirm, the previous key stops working. Update every integration that uses it. There is one key per account, so generating a new one always replaces the old one.

Treat the key like a password. Anyone who has it can read your statistics.

The query builder

The rest of the screen builds a query URL for you. You do not have to use it — you can write the URL by hand once you know the parameters (Article 4.) — but it is the quickest way to get a working one.

Control

What it does

Start date

first day of the period you want

End date

last day of the period, included

Report breakdown

By Dates (one row per day) or By Months (one row per month)

Group data by

which report to pull — Accounts, Brands, Campaigns, and Dynamic variables / Players / Geo / Postbacks if your plan includes them

Labels

tick to have your own brand and campaign labels returned instead of the names the affiliate program uses

Report currency

convert every monetary value to one currency. Leave it on Select… to keep each account in its own currency

Tags filter

restrict the report to accounts (or brands/campaigns) carrying the tags you pick

Match Any / Match All

with Match Any, one matching tag is enough; with Match All, every selected tag must be present

Query URL

the finished URL, rebuilt as you change anything above

Copy to Clipboard

copies the query URL

Things the form will do on its own:

  • By Months is unavailable for Dynamic Variables and Postbacks. Selecting either of those greys the option out, switches the breakdown back to By Dates, and shows the reason. Those two reports are collected per day and per event; there is nothing to add up into a month that would still be the same thing.

  • Dates outside your plan's history are refused. Pick a start or end date further back than your plan allows and the form shows the limit instead of building a URL.

  • The Match Any / Match All setting is saved. It is your account's API tags preference, not a one-off choice for this URL.

Paste the finished URL into a browser to see the JSON, or into whatever system is going to consume it.

Did this answer your question?