Monetization

• Please note that revenue reporting is not finalised until at least 7-10 days after the point of conversion
• The endpoint for this service will be provided to you by your Tappa representative
• Due to the potentially large quantity of data returned, please ensure that you follow any redirect that this returns; this service returns an HTTP 303 redirect in cases that the body exceeds 1Mb.

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
• For campaigns where we are bidding in real-time on your traffic there are two report types available, ‘rtb’ for a summary report and ‘rtb-by-subid’ for a detailed report by subid (clickId). You can additionally pass a specific subid using the query parameter sub_id to return only revenue relating to that specific sub_id.
• Extra detail is available by passing one of the following as the detail query parameter: with_source_id , by_source_id , by_subid.
• If requesting extra detail by_source_id you must also supply a source_id in the body of the request.
• It is also possible to request a more detailed breakdown for by_source_id and with_source_id reports by using the breakdown report type

Note that where campaigns contain a component relating to affiliate purchases, revenue figures are only finalised after 7 elapsed days, before which 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"
}

Specifically in cURL this will look something like:

curl -X POST '{{ REPORTING HOSTNAME }}/campaign/revenue' \\
-H 'Content-Type: application/json' \\
-H 'Authorization: Bearer oveTr2htUYjYDH3Z8wpHzu' \\
--data-raw '  {
    "client_id": "{{ YOUR CLIENT ID}}",
    "campaign_id": "{{ YOUR CAMPAIGN ID}}",
    "start_date": "2022-12-01",
    "end_date": "2022-12-31"
  }'