GET /offerConversions  API documentation

Get the list of conversions (similar to the conversions log) with optional filters.

GET https://demo.trafficmanager.com/api/v1/offerConversions/{startTime}/{endTime}/?fields={fields}

Authentication:

The request must be authenticated with the following HTTP headers:
  • x-api-key: Your API key, found in the Security page
  • x-user-id: Your User ID, found in 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. Unix timestamp or any value accepted by strtotime. For example: 2023-01-01, today, -10 minutes...
  • endTime: End time. Unix timestamp or any value accepted by strtotime. For example: 2023-01-01 23:59:59, today 23:59:59, -5 minutes...
  • fields: comma-separated list of the fields to be returned. See below.
  • Optional:
  • offer_id: offer ID filter
  • clickid: clickid. If this value is set, all the other filters will be ignored. With this filter, the API will return only one result, or none.
  • limit: maximum number of results. If greater than 1000000, it will be set to 1000000. Default: 10000
  • offset: first row of the dataset to return. For example, to retrieve the “3th page” of records (records 101 - 150) where you are using limit to page 50 records at a time, you’d ask for an offset of 100. Default: 0.
  • csv: if set, the response will be returned in CSV format instead of JSON

Returned values:

  • The returned values depend on the selected fields. See below.

Fields:

  • By using the fields parameter, you can select which fields you want to receive in the response. The following ones are available:
  • id: ID of the conversion
  • status: status of the conversion. Possible values are: Pending, Approved, Canceled.
  • timestamp: date and time of the conversion
  • click_date: date and time of the click that generated the conversion
  • clickid: TrafficManager clickid
  • n: incremental number of conversions generated by this clickid
  • payout: Revenue paid to the affiliate for the conversion (in EUR)
  • offer_id: ID of the offer
  • offer_name: name of the offer
  • lp_id: ID of the offer landing page
  • cc: country code
  • ip: full IPv4 or IPv6
  • device_id: device ID (see this reference table)
  • subid: parameter passed by the affiliate in the tracking link
  • subid2: parameter passed by the affiliate in the tracking link
  • subid3: parameter passed by the affiliate in the tracking link
  • subid4: parameter passed by the affiliate in the tracking link
  • pubid: parameter passed by the affiliate in the tracking link
  • utm_source: parameter passed by the affiliate in the tracking link
  • utm_medium: parameter passed by the affiliate in the tracking link
  • utm_campaign: parameter passed by the affiliate in the tracking link
  • utm_term: parameter passed by the affiliate in the tracking link
  • utm_content: parameter passed by the affiliate in the tracking link

Request example

GET https://demo.trafficmanager.com/api/v1/offerConversions/2025-01-01/yesterday 23:59:59/?fields=status,timestamp,offer_id,user_id,amount,payout,clickid,subid2&limit=5

Response example

[
    {
        "status": "Pending",
        "timestamp": "2025-04-24 10:48:17",
        "offer_id": "8",
        "user_id": "2",
        "amount": "25.0000",
        "payout": "14.3500",
        "clickid": "DEV9D15DFAE356DD7F937A7F37723DB3A3D"
    },
    {
        "status": "Approved",
        "timestamp": "2025-04-24 10:48:17",
        "offer_id": "8",
        "user_id": "2",
        "amount": "10.0000",
        "payout": "7.0000",
        "clickid": "DEV9D15DFAE356DD7F937A7F37723DB3A3D"
    },
    {
        "status": "Canceled",
        "timestamp": "2025-04-24 10:22:39",
        "offer_id": "8",
        "user_id": "2",
        "amount": "10.0000",
        "payout": "7.0000",
        "clickid": "DEVC49B6CA6C7EC6DB1703C370BCFBBB0B4"
    },
    {
        "status": "Approved",
        "timestamp": "2025-04-24 10:22:39",
        "offer_id": "8",
        "user_id": "2",
        "amount": "55.0000",
        "payout": "34.3500",
        "clickid": "DEVC49B6CA6C7EC6DB1703C370BCFBBB0B4"
    },
    {
        "status": "Canceled",
        "timestamp": "2025-04-24 10:20:26",
        "offer_id": "8",
        "user_id": "2",
        "amount": "10.0000",
        "payout": "7.0000",
        "clickid": "DEV296A982D650C7EAC9A287EB64263AB5E"
    }
]

CSV

You can also get the response in CSV instead of JSON. Simply add csv=1 as a GET parameter.

Request example:

GET https://demo.trafficmanager.com/api/v1/offerConversions/2025-01-01/yesterday 23:59:59/?fields=timestamp,offer_id,user_id,clickid,subid2&limit=10&csv=1

Response example:

timestamp,offer_id,user_id,amount,payout,clickid
"2025-04-24 10:48:17",8,2,25.0000,14.3500,DEV9D15DFAE356DD7F937A7F37723DB3A3D
"2025-04-24 10:48:17",8,2,10.0000,7.0000,DEV9D15DFAE356DD7F937A7F37723DB3A3D
"2025-04-24 10:22:39",8,2,10.0000,7.0000,DEVC49B6CA6C7EC6DB1703C370BCFBBB0B4
"2025-04-24 10:22:39",8,2,55.0000,34.3500,DEVC49B6CA6C7EC6DB1703C370BCFBBB0B4
"2025-04-24 10:20:26",8,2,10.0000,7.0000,DEV296A982D650C7EAC9A287EB64263AB5E
Server time (UTC): 2025-04-25 14:49:10 - Powered by TrafficManager version fdbc2a078 (2025-04-24)