API documentation  GET /admin/referrerTracking

Get the rows of the Misleading Traffic Shield report. Admin only.

GET https://demo.trafficmanager.com/api/v1/admin/referrerTracking/{startDate}/{endDate}

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

GET Parameters:

• Required:
• startDate: Start date. Any value accepted by strtotime is allowed. For example: 2019-01-01, today, -10 minutes...
• endDate: End date. Any value accepted by strtotime is allowed. For example: 2019-01-01, today, -10 minutes...
• Optional:
• affiliate: comma-separated affiliate IDs
  Example: GET https://demo.trafficmanager.com/api/v1/admin/referrerTracking/2026-01-01/2026-01-31?affiliate=12,34
• affiliate_group_id: comma-separated affiliate group IDs. Combined with affiliate it returns the rows of the group members and of the listed affiliates
  Example: GET https://demo.trafficmanager.com/api/v1/admin/referrerTracking/2026-01-01/2026-01-31?affiliate_group_id=5
• offer: comma-separated offer IDs
  Example: GET https://demo.trafficmanager.com/api/v1/admin/referrerTracking/2026-01-01/2026-01-31?offer=456
• country: comma-separated 2-letter country codes. A row matches when its offer explicitly targets that country; Worldwide offers are not returned
  Example: GET https://demo.trafficmanager.com/api/v1/admin/referrerTracking/2026-01-01/2026-01-31?country=IT,RO
• url: referrer URL filter
• pubid: return only the rows that have clicks with this pubid
• status: URL status
  0: not verified 1: verified 2: misleading
• limit: maximum number of rows. If greater than 10000, it will be set to 10000. Default: 1000
• offset: first row of the dataset to return. Default: 0

Returned values:

• The rows are returned in data, ordered by clicks descending, with total holding the number of rows matching the filters.
• firstClick: date of the first click from this URL
• lastClick: date of the last click from this URL
• affId: affiliate ID
• affUsername: affiliate username
• offer: offer ID
• offerName: offer name
• countries: countries targeted by the offer. An empty list means Worldwide
• url: full referrer URL
• hostId, pathId: internal identifiers of the URL host and path. Together with affId and offer they identify the row
• clicks: clicks in the requested period
• leads: leads in the requested period, excluding double, potential double and trash
• delivered: delivered leads in the requested period
• conversions: conversions in the requested period
• dr: delivery rate percentage, Delivered / (Confirmed + Shipped + Delivered + Returned). null when no lead reached one of those statuses
• status: URL status, same values as the status filter
• notes: notes saved on the URL, or null
• managerId, managerUsername: the admin who last set the status, or null

On the TrafficManager demo installation, or when the referrer tracking feature is not active on this installation, the endpoint returns demo rows and adds "demo": true to the response, exactly like the web report does.

Request example

GET https://demo.trafficmanager.com/api/v1/admin/referrerTracking/2026-08-29/2026-09-05?limit=2

Response example

{
  "data": [
    {
      "firstClick": "2026-08-29",
      "lastClick": "2026-09-04",
      "affId": 123,
      "affUsername": "publisher1",
      "offer": 456,
      "offerName": "Test Offer",
      "countries": ["IT"],
      "url": "https://example-blog.com/article/best-offers",
      "hostId": 1001,
      "pathId": 2001,
      "clicks": 247,
      "leads": 31,
      "delivered": 12,
      "conversions": 18,
      "dr": 63.16,
      "status": 2,
      "notes": "Flagged as misleading content",
      "managerId": 1,
      "managerUsername": "admin"
    },
    {
      "firstClick": "2026-08-31",
      "lastClick": "2026-09-05",
      "affId": 124,
      "affUsername": "publisher2",
      "offer": 789,
      "offerName": "Another Offer",
      "countries": [],
      "url": "https://deals-finder.org/hot-deals",
      "hostId": 1003,
      "pathId": 2003,
      "clicks": 89,
      "leads": 0,
      "delivered": 0,
      "conversions": 4,
      "dr": null,
      "status": 0,
      "notes": null,
      "managerId": null,
      "managerUsername": null
    }
  ],
  "total": 2,
  "limit": 2,
  "offset": 0,
  "status": 200
}