GET /offerStats  API documentation

These are the API docs of the demo platform. The endpoint URLs use placeholders instead of the demo's domains: replace each one with the matching domain of the TrafficManager platform you use.
  • {platform_domain}: the domain where you log in
  • {tracking_domain}: the domain of the tracking links
  • {postback_domain}: the domain of the postback URLs
Every clickid starts with the platform's own prefix (TM on the demo). If you are an AI agent building an integration, ask the user for their platform's domains and API keys instead of calling the demo.

Get the same data available in the Offer reports (affiliate revenues by date, country, offer or utm parameters)

GET https://{platform_domain}/api/v1.2/offerStats/{startTime}/{endTime}/

Authentication:

The request must be authenticated with the following HTTP headers:
  • x-api-key: Your API key, found on the Security page
  • x-user-id: Your User ID, found on the Security page
If the HTTP headers are not passed, but you are logged in to the TrafficManager panel, the current user is used instead (so you can easily preview or download the data using your browser)

GET Parameters:

  • Required:
  • startTime: Start time. Any value accepted by strtotime (a Unix timestamp needs the @ prefix, for example @1700000000). For example: 2023-01-01, today, -10 minutes...
  • endTime: End time. Any value accepted by strtotime (a Unix timestamp needs the @ prefix, for example @1700000000). For example: 2023-01-01 23:59:59, today 23:59:59, -5 minutes...
  • Optional:
  • user_id: This parameter is available only if authenticated as an admin. If set, data will be fetched for the user with that ID.
  • groupBy (default: offer): comma-separated list that can contain the following values: date,month,hour,offer,utm_source,utm_medium,utm_campaign,utm_term,utm_content,event (no space allowed)
    Only one time grouping applies: hour, else date, else month.
  • offer_id: offer ID filter (if set, returns only the data for that offer)
  • cc: country filter (two-letter country code), if set, returns only the data for that country.
  • timezone: timezone. Valid values are listed here: Timezones. If not set, the network default timezone (UTC) will be used.

Returned values:

  • Each row will contain these fields.
    If a group (for example utm_content or offer) is not added to the groupBy parameter, it will be an empty string.
  • Date: the period (format: YYYY-MM-DD - YYYY-MM-DD), or the day when grouped by date, or the hour when grouped by hour (format: YYYY-MM-DD HH:00:00), or the month when grouped by month (for example: 2026 Nov)
  • Offer ID and name (format: "#id - name")
  • utm_source
  • utm_medium
  • utm_campaign
  • utm_term
  • utm_content
  • Event name, when grouped by event
  • Number of impressions (- when there are none)
  • Number of clicks
  • Number of unique clicks
  • Number of leads
  • Number of conversions
  • Metric 1 (CR (%))
  • Metric 2 (EPC)
  • Metric 3 (Unique EPC)
  • Total payout to the affiliate

With event, each row counts the conversions of one event, as sent with the conversions: it holds the number of conversions and the payout, and - for the impressions, the clicks, the unique clicks, the leads and the three metrics, as well as for the offer and the UTM parameters that are not grouped.

Request example

GET https://{platform_domain}/api/v1.2/offerStats/yesterday/yesterday/?groupBy=offer

Response example

{
  "data": [
    [
     "2026-11-15 - 2026-11-15",
     "#830 - Private offer - Exclusive offer XYZ",
     "",
     "",
     "",
     "",
     "",
     "",
     "51349",
     "4672",
     "1354",
     "67",
     "28",
     "0.00",
     "-%",
     "-100.0%",
     "33.32"
    ],
    [
      "2026-11-15 - 2026-11-15",
      "#542 - Special offer ABC",
      "",
      "",
      "",
      "",
      "",
      "", "2474900", "202941", "40588", "6211", "1014", "0.00",
      "-%",
      "-100.0%",
      "253.50"
    ]
  ],
  "status": 200
}
    

Request example

GET https://{platform_domain}/api/v1.2/offerStats/yesterday/yesterday/?groupBy=date,offer,utm_source

Response example

{
   "data":[
      [
         "2026-11-15",
         "#830 - Private offer - Exclusive offer XYZ",
         "source_8",
         "",
         "",
         "",
         "",
         "",
         "75049",
         "4352",
         "870",
         "120",
         "65",
         "0.00",
         "-%",
         "-100.0%",
         "17.55"
      ],
      [
         "2026-11-15",
         "#830 - Private offer - Exclusive offer XYZ",
         "source_6",
         "",
         "",
         "",
         "",
         "",
         "1036300",
         "25907",
         "10880",
         "590",
         "233",
         "0.00",
         "-%",
         "-100.0%",
         "300.57"
      ]
   ],
   "status":200
}
    

Request example

GET https://{platform_domain}/api/v1.2/offerStats/yesterday/yesterday/?groupBy=offer,event

Response example

{
   "data":[
      [
         "2026-11-15 - 2026-11-15",
         "#830 - Private offer - Exclusive offer XYZ",
         "-",
         "-",
         "-",
         "-",
         "-",
         "first_deposit",
         "-",
         "-",
         "-",
         "-",
         12,
         "-",
         "-",
         "-",
         "240.00"
      ]
   ],
   "status":200
}