Our APIs provide granular reporting data, with breakdowns by campaign, date, sub-id, domain

Monetization

(Note that this endpoint is provided at reporting.{SEARCHDOMAIN})

POST /campaign/revenue/{report type - optional}

Retrieve monetization for the period given.

• For campaigns where you are searching or linking via our URLs, leave the report type blank for a summary report or append ?detail=true for a report by domain

Note that where campaigns contain a component relating to affiliate purchases, revenue figures are only finalised when confirmed, and prior to this provisional figures are shown. Your Tappa Search representative can provide more details and if required a full breakdown.

POST /campaign/revenue
Host: reporting.{SEARCHDOMAIN}
Accept: application/json, text/javascript
Authorization: { Your Token }

{
  "client_id": "23r88j8r",
  "campaign_id": "2378f",
  "start_date": "2018-09-05",
  "end_date":  "2018-09-06"
}

Request JSON Object:

• client_id (string) – Your API client id
• campaign_id (string) – The campaign id that this request relates to
• start_date (string) – Start date of the period to find data for, as YYYY-MM-DD
• end_date (string) – End date of the period to find data for, as YYYY-MM-DD

Example response:

"2018-09-05": [
        {
            "rev_date": "2018-09-05",
            "campaign_id": "23892fu8923u983",
            "clicks": 421,
            "revenue": 98.3,
            "rpc": 0.230
        },
    ],
    "2018-09-06": [
         {
            "rev_date": "2018-09-06",
            "campaign_id": "23892fu8923u983",
            "clicks": 221,
            "revenue": 28.3
            "rpc": 0.128
        }
    ]
}

:statuscode 200: No error
:statuscode 404: There is no matching campaign or user id
:statuscode 403: Permission denied
:statuscode 401: Not authenticated