RTB API

Using merchenta.io for real-time bidding

Reporting 

Our platform provides the ability to generate numerous kinds of different reports:

  • billing reports
  • reports for all campaigns/single campaign grouped by day
  • cumulative reports for all campaigns/single campaign
  • publisher reports for single campaign grouped by day
  • realtime reports for all campaigns/single campaign grouped by hour from midnight UTC

We provided canned datasets of anonymised sample data in sandbox environments to enable initial integration and testing. This can be useful to overcome the “chicken-and-egg” scenario when building reports/screens that require report data before you are able to run real campaigns to generate that data.

The canned datasets are available for a special “SANDBOX1” advertiser for dates between 2014-03-10 and 2014-04-20. Please contact Support for details of the special login and password for this account if you wish to use canned datasets.

Billing Report - Endpoint A 

Gets detailed billing report for the given advertiser between the supplied dates in the given currency (if currency is not passed then the default advertiser’s currency is used).

Note This endpoint only supports historical reports! For latest (today’s) report call reporting Endpoint B

/v3/reporting/billing/{advertiserCode}/{startDate}/{endDate}/{currencyCode}
  • Parameters
  • advertiserCode
    string (required) Example: MERCHNETA

    The advertiser ID

    startDate
    string (required) Example: 2014-09-01

    The start date

    endDate
    string (required) Example: 2014-09-14

    The end date

    currencyCode
    string (optional) Example: GBP

    The currency codeIf parameter is not passed then default advertiser’s currency is used.

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/billing/MERCHNETA/2014-09-01/2014-09-14/GBP
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "reportDate": "2013-05-20",
                    "advertiserCode": "MERCHENTAFAKE",
                    "netSpendInUsd": 21.11,
                    "grossSpendInUsd": 300,
                    "currencyCode": "USD",
                    "netSpendInCcy": 21.11,
                    "grossSpendInCcy": 300,
                    "impressions": 4000,
                    "eCPMNetInUsd": 5.28,
                    "eCPMGrossInUsd": 75,
                    "fxRate": 1
                },
                {
                    "reportDate": "2013-05-21",
                    "advertiserCode": "MERCHENTAFAKE",
                    "netSpendInUsd": 21.11,
                    "grossSpendInUsd": 300,
                    "currencyCode": "USD",
                    "netSpendInCcy": 21.11,
                    "grossSpendInCcy": 300,
                    "impressions": 4000,
                    "eCPMNetInUsd": 5.28,
                    "eCPMGrossInUsd": 75,
                    "fxRate": 1
                }
            ]
        }
    }
  • Response  400
  • Response  404

Billing Report - Endpoint B 

Gets summary billing information for today, month-to-date (MTD) and year-to-date (YTD) for the given advertiser.

Note This endpoint only supports billing reports for a period ending today. For historical reports use Endpoint A instead.

/v3/reporting/billing/{advertiserCode}
  • Parameters
  • advertiserCode
    string (required) Example: MERCHENTA

    The advertiser ID

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/billing/MERCHENTA
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "report": {
                "reportDate": "2014-10-29",
                "advertiserCode": "MERCHENTAFAKE",
                "currentGrossBalanceInUsd": 100,
                "currentGrossBalanceInCcy": 158.04,
                "todayNetSpendInUsd": 20,
                "todayGrossSpendInUsd": 20,
                "MTDNetSpendInUsd": 100,
                "MTDGrossSpendInUsd": 100,
                "YTDNetSpendInUsd": 300,
                "YTDGrossSpendInUsd": 300,
                "alltimeNetSpendInUsd": 700,
                "alltimeGrossSpendInUsd": 700,
                "currencyCode": "GBP",
                "todayNetSpendInCcy": 31.61,
                "todayGrossSpendInCcy": 31.61,
                "MTDNetSpendInCcy": 158.04,
                "MTDGrossSpendInCcy": 158.04,
                "YTDNetSpendInCcy": 474.11,
                "YTDGrossSpendInCcy": 474.11,
                "alltimeNetSpendInCcy": 1106.26,
                "alltimeGrossSpendInCcy": 1106.26
            }
        }
    }

Billing Report - Account transaction details 

Gets detailed account transactions billing report for the given advertiser between the supplied dates.

/v3/reporting/billing/account/transactions/{advertiserCode}/{startDate}/{endDate}
  • Parameters
  • advertiserCode
    string (required) Example: MERCHNETA

    The advertiser ID

    startDate
    string (required) Example: 2014-09-01

    The start date

    endDate
    string (required) Example: 2014-09-14

    The end date

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/billing/account/transactions/MERCHNETA/2014-09-01/2014-09-14
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
      "status": "success",
      "data": {
        "reports": [
          {
            "transactionDate": "2014-10-29",
            "advertiserCode": "MERCHENTAFAKE",
            "transactionReference": "ref 0001",
            "transactionProcessed": "2014-10-29 10:00",
            "transactionType": "CARD",
            "description": "Media exchange topup",
            "currencyCode": "GBP",
            "transactionAmountinCcy": 1234.00,
            "transactionAmountInUsd": 1836.00
          },
          {
            "transactionDate": "2014-10-01",
            "advertiserCode": "MERCHENTAFAKE",
            "transactionReference": "ref 0002",
            "transactionProcessed": "2014-10-01 17:07",
            "transactionType": "WIRE",
            "description": "Media budget",
            "currencyCode": "GBP",
            "transactionAmountinCcy": 1000.00,
            "transactionAmountInUsd": 1500.00
          },
          {
            "transactionDate": "2014-07-31",
            "advertiserCode": "MERCHENTAFAKE",
            "transactionReference": "20140731",
            "transactionProcessed": "2014-07-31",
            "transactionType": "MEDIA",
            "description": "Medica charges : 86,080 impressions",
            "currencyCode": "GBP",
            "transactionAmountinCcy": -1000.00,
            "transactionAmountInUsd": -1500.00
          }
        ]
      }
    }
  • Response  400
  • Response  404

Campaign summary reports 

Gets an end-of-day campaign report between the specified dates for the advertiser. The reports are presented in report date order.

/v3/reporting/campaigns/{startDate}/{endDate}
  • Parameters
  • startDate
    string (required) Example: 2013-12-01

    The start date

    endDate
    string (required) Example: 2013-12-02

    The end date

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/campaigns/2013-12-01/2013-12-02
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "reportDate": "2013-12-01",
                    "advertiserCode": "MERCHENTA",
                    "campaignCode": "FBX-TEST-08",
                    "auctions": 20589,
                    "bidsPlaced": 2982,
                    "won": 964,
                    "impressions": 964,
                    "clicks": 0,
                    "engagements": 50,
                    "uniqueClicks": 0,
                    "uniqueEngagements": 0,
                    "winRate": 32.33,
                    "displayRate": 100,
                    "currencyCode": "GBP",
                    "netMediaSpend": 0,
                    "grossMediaSpend": 0.12,
                    "mediaMargin": 0,
                    "status":"ACTIVE",
                    "budget":10,
                    "lifetimeBudget":1000
                },
                {
                    "reportDate": "2013-12-02",
                    "advertiserCode": "MERCHENTA",
                    "campaignCode": "FBX-TEST-08",
                    "auctions": 29914,
                    "bidsPlaced": 4341,
                    "won": 1363,
                    "impressions": 1363,
                    "clicks": 0,
                    "engagements": 25,
                    "uniqueClicks": 0,
                    "uniqueEngagements": 0,
                    "winRate": 31.4,
                    "displayRate": 100,
                    "currencyCode": "GBP",
                    "netMediaSpend": 0,
                    "grossMediaSpend": 0.24,
                    "mediaMargin": 0,
                    "status":"ACTIVE",
                    "budget":10,
                    "lifetimeBudget":1000
                },
                {
                    "reportDate": "2013-12-01",
                    "advertiserCode": "MERCHENTA",
                    "campaignCode": "MTA-MAY13-IMU-B",
                    "auctions": 20589,
                    "bidsPlaced": 33072,
                    "won": 953,
                    "impressions": 953,
                    "clicks": 0,
                    "engagements": 25,
                    "uniqueClicks": 0,
                    "uniqueEngagements": 0,
                    "winRate": 2.89,
                    "displayRate": 100,
                    "currencyCode": "GBP",
                    "netMediaSpend": 0,
                    "grossMediaSpend": 1.73,
                    "mediaMargin": 0,
                    "status":"ACTIVE",
                    "budget":10,
                    "lifetimeBudget":1000
                },
                {
                    "reportDate": "2013-12-02",
                    "advertiserCode": "MERCHENTA",
                    "campaignCode": "MTA-MAY13-IMU-B",
                    "auctions": 29914,
                    "bidsPlaced": 50629,
                    "won": 1313,
                    "impressions": 1310,
                    "clicks": 0,
                    "engagements": 25,
                    "uniqueClicks": 0,
                    "uniqueEngagements": 0,
                    "winRate": 2.6,
                    "displayRate": 99.78,
                    "currencyCode": "GBP",
                    "netMediaSpend": 0,
                    "grossMediaSpend": 2.66,
                    "mediaMargin": 0,
                    "status":"ACTIVE",
                    "budget":10,
                    "lifetimeBudget":1000
                },
                {
                    "reportDate": "2013-12-01",
                    "advertiserCode": "MERCHENTA",
                    "campaignCode": "MTA-RUSS-LB-B",
                    "auctions": 20589,
                    "bidsPlaced": 30377,
                    "won": 795,
                    "impressions": 795,
                    "clicks": 1,
                    "engagements": 0,
                    "uniqueClicks": 1,
                    "uniqueEngagements": 0,
                    "winRate": 2.62,
                    "displayRate": 100,
                    "currencyCode": "GBP",
                    "netMediaSpend": 0,
                    "grossMediaSpend": 2.62,
                    "mediaMargin": 0,
                    "status":"ACTIVE",
                    "budget":10,
                    "lifetimeBudget":1000
                },
                {
                    "reportDate": "2013-12-02",
                    "advertiserCode": "MERCHENTA",
                    "campaignCode": "MTA-RUSS-LB-B",
                    "auctions": 29914,
                    "bidsPlaced": 35550,
                    "won": 1184,
                    "impressions": 1184,
                    "clicks": 0,
                    "engagements": 50,
                    "uniqueClicks": 0,
                    "uniqueEngagements": 0,
                    "winRate": 3.34,
                    "displayRate": 100,
                    "currencyCode": "GBP",
                    "netMediaSpend": 0,
                    "grossMediaSpend": 4.57,
                    "mediaMargin": 0,
                    "status":"ACTIVE",
                    "budget":10,
                    "lifetimeBudget":1000
                }
            ]
        }
    }
  • Response  400

Campaign report 

Gets report for given campaign between dates for current advertiser. The reports are presented in report date order.

/v3/reporting/campaigns/{campaignCode}/{startDate}/{endDate}
  • Parameters
  • campaignCode
    string (required) Example: FBX-TEST-08

    The campaign code

    startDate
    string (required) Example: 2013-12-01

    The start date

    endDate
    string (required) Example: 2013-12-02

    The end date

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/campaigns/FBX-TEST-08/2013-12-01/2013-12-02
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "reportDate": "2013-12-01",
                    "advertiserCode": "MERCHENTA",
                    "campaignCode": "FBX-TEST-08",
                    "auctions": 20589,
                    "bidsPlaced": 2982,
                    "won": 964,
                    "impressions": 964,
                    "clicks": 0,
                    "engagements": 50,
                    "uniqueClicks": 0,
                    "uniqueEngagements": 0,
                    "winRate": 32.33,
                    "displayRate": 100,
                    "currencyCode": "GBP",
                    "netMediaSpend": 0,
                    "grossMediaSpend": 0.08,
                    "mediaMargin": 0,
                    "status":"ACTIVE",
                    "budget":10,
                    "lifetimeBudget":1000,
                    "creatives": [
                        {
                            "creativeCode": "FBX-TEST-08-1",
                            "approvalStatus": "ACTIVE",
                            "auctions": 20589,
                            "bidsPlaced": 2982,
                            "won": 964,
                            "impressions": 964,
                            "clicks": 0,
                            "engagements": 0,
                            "uniqueClicks": 0,
                            "uniqueEngagements": 0,
                            "winRate": 32.33,
                            "displayRate": 100,
                            "netMediaSpend": 0,
                            "grossMediaSpend": 0.08,
                            "mediaMargin": 0
                        },
                        {
                            "creativeCode": "FBX-TEST-08-2",
                            "approvalStatus": "PENDING",
                            "auctions": 0,
                            "bidsPlaced": 0,
                            "won": 0,
                            "impressions": 0,
                            "clicks": 0,
                            "engagements": 0,
                            "uniqueClicks": 0,
                            "uniqueEngagements": 0,
                            "winRate": 0,
                            "displayRate": 0,
                            "netMediaSpend": 0,
                            "grossMediaSpend": 0.0,
                            "mediaMargin": 0
                        }
                    ]
                },
                {
                    "reportDate": "2013-12-02",
                    "advertiserCode": "MERCHENTA",
                    "campaignCode": "FBX-TEST-08",
                    "auctions": 29914,
                    "bidsPlaced": 4341,
                    "won": 1363,
                    "impressions": 1363,
                    "clicks": 0,
                    "engagements": 25,
                    "uniqueClicks": 0,
                    "uniqueEngagements": 0,
                    "winRate": 31.4,
                    "displayRate": 100,
                    "currencyCode": "GBP",
                    "netMediaSpend": 0,
                    "grossMediaSpend": 0.15,
                    "mediaMargin": 0,
                    "status":"ACTIVE",
                    "budget":10,
                    "lifetimeBudget":1000,
                    "creatives": [
                        {
                            "creativeCode": "FBX-TEST-08-1",
                            "approvalStatus": "ACTIVE",
                            "auctions": 29914,
                            "bidsPlaced": 4341,
                            "won": 1363,
                            "impressions": 1363,
                            "clicks": 0,
                            "engagements": 25,
                            "uniqueClicks": 0,
                            "uniqueEngagements": 0,
                            "winRate": 31.4,
                            "displayRate": 100,
                            "currencyCode": "GBP",
                            "netMediaSpend": 0,
                            "grossMediaSpend": 0.15,
                            "mediaMargin": 0
                        },
                        {
                            "creativeCode": "FBX-TEST-08-2",
                            "approvalStatus": "PENDING",
                            "auctions": 0,
                            "bidsPlaced": 0,
                            "won": 0,
                            "impressions": 0,
                            "clicks": 0,
                            "engagements": 0,
                            "uniqueClicks": 0,
                            "uniqueEngagements": 0,
                            "winRate": 0,
                            "displayRate": 0,
                            "netMediaSpend": 0,
                            "grossMediaSpend": 0.0,
                            "mediaMargin": 0
                        }
                    ]
                }
            ]
        }
    }
  • Response  400
  • Response  404

Campaign summary cumulative reports 

Gets all campaigns cumulative reports between dates for current advertiser.

Note Cumulative report means that all reports between startDate and endDate are summed up and returned as one overall report.

/v3/reporting/campaigns/cumulative/{startDate}/{endDate}
  • Parameters
  • startDate
    string (required) Example: 2013-12-01

    The start date

    endDate
    string (required) Example: 2013-12-02

    The end date

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/campaigns/cumulative/2013-12-01/2013-12-02
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "reportDate": "2013-12-02",
                    "advertiserCode": "MERCHENTA",
                    "campaignCode": "FBX-TEST-08",
                    "auctions": 50503,
                    "bidsPlaced": 7323,
                    "won": 2327,
                    "impressions": 2327,
                    "clicks": 0,
                    "engagements": 75,
                    "uniqueClicks": 0,
                    "uniqueEngagements": 0,
                    "winRate": 31.87,
                    "displayRate": 100,
                    "currencyCode": "GBP",
                    "netMediaSpend": 0,
                    "grossMediaSpend": 0.23,
                    "mediaMargin": 0,
                    "status":"ACTIVE",
                    "budget":10,
                    "lifetimeBudget":1000
                },
                {
                    "reportDate": "2013-12-02",
                    "advertiserCode": "MERCHENTA",
                    "campaignCode": "MTA-MAY13-IMU-B",
                    "auctions": 50503,
                    "bidsPlaced": 83701,
                    "won": 2266,
                    "impressions": 2263,
                    "clicks": 0,
                    "engagements": 50,
                    "uniqueClicks": 0,
                    "uniqueEngagements": 0,
                    "winRate": 2.74,
                    "displayRate": 99.89,
                    "currencyCode": "GBP",
                    "netMediaSpend": 0,
                    "grossMediaSpend": 2.78,
                    "mediaMargin": 0,
                    "status":"ACTIVE",
                    "budget":10,
                    "lifetimeBudget":1000
                },
                {
                    "reportDate": "2013-12-02",
                    "advertiserCode": "MERCHENTA",
                    "campaignCode": "MTA-RUSS-LB-B",
                    "auctions": 50503,
                    "bidsPlaced": 65927,
                    "won": 1979,
                    "impressions": 1979,
                    "clicks": 1,
                    "engagements": 50,
                    "uniqueClicks": 1,
                    "uniqueEngagements": 0,
                    "winRate": 2.98,
                    "displayRate": 100,
                    "currencyCode": "GBP",
                    "netMediaSpend": 0,
                    "grossMediaSpend": 4.55,
                    "mediaMargin": 0,
                    "status":"ACTIVE",
                    "budget":10,
                    "lifetimeBudget":1000
                }
            ]
        }
    }
  • Response  400

Campaign cumulative report 

Gets cumulative report for given campaign between dates for current advertiser.

/v3/reporting/campaigns/{campaignCode}/cumulative/{startDate}/{endDate}
  • Parameters
  • campaignCode
    string (required) Example: FBX-TEST-08

    The campaign code

    startDate
    string (required) Example: 2013-12-01

    The start date

    endDate
    string (required) Example: 2013-12-02

    The end date

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/campaigns/FBX-TEST-08/cumulative/2013-12-01/2013-12-02
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "report": {
                "reportDate": "2013-12-02",
                "advertiserCode": "MERCHENTA",
                "campaignCode": "FBX-TEST-08",
                "auctions": 50503,
                "bidsPlaced": 7323,
                "won": 2327,
                "impressions": 2327,
                "clicks": 0,
                "engagements": 75,
                "uniqueClicks": 0,
                "uniqueEngagements": 0,
                "winRate": 31.87,
                "displayRate": 100,
                "currencyCode": "GBP",
                "netMediaSpend": 0,
                "grossMediaSpend": 0.23,
                "mediaMargin": 0,
                "status":"ACTIVE",
                "budget":10,
                "lifetimeBudget":1000,
                "creatives": [
                    {
                        "creativeCode": "FBX-TEST-08-1",
                        "approvalStatus": "ACTIVE",
                        "auctions": 50503,
                        "bidsPlaced": 7323,
                        "won": 2327,
                        "impressions": 2327,
                        "clicks": 0,
                        "engagements": 75,
                        "uniqueClicks": 0,
                        "uniqueEngagements": 0,
                        "winRate": 31.87,
                        "displayRate": 100,
                        "currencyCode": "GBP",
                        "netMediaSpend": 0,
                        "grossMediaSpend": 0.23,
                        "mediaMargin": 0
                    },
                    {
                        "creativeCode": "FBX-TEST-08-2",
                        "approvalStatus": "PENDING",
                        "auctions": 0,
                        "bidsPlaced": 0,
                        "won": 0,
                        "impressions": 0,
                        "clicks": 0,
                        "engagements": 0,
                        "uniqueClicks": 0,
                        "uniqueEngagements": 0,
                        "winRate": 0,
                        "displayRate": 0,
                        "netMediaSpend": 0,
                        "grossMediaSpend": 0.0,
                        "mediaMargin": 0
                    }
                ]
            }
        }
    }
  • Response  400
  • Response  404

Campaign publishers reports 

Gets the publishers reports with details of sites where campaign has run between dates. The reports are presented in report date order.

Note Note that where a campaign has been run on BLIND inventory, the publisher URL will not usually be available – it will appear as null or undefined.

/v3/reporting/campaigns/{campaignCode}/publishers/{startDate}/{endDate}
  • Parameters
  • campaignCode
    string (required) Example: MERCHENTAFAKE-test-campaign-1

    The advertiser ID

    startDate
    string (required) Example: 2013-05-20

    The start date

    endDate
    string (required) Example: 2013-05-21

    The end date

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/campaigns/MERCHENTAFAKE-test-campaign-1/publishers/2013-05-20/2013-05-21
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "publishers": [
                {
                    "reportDate": "2013-05-20",
                    "advertiserCode": "MERCHENTAFAKE",
                    "campaignCode": "MERCHENTAFAKE-test-campaign-1",
                    "publisher": "www.onet.pl",
                    "impressions": 40000,
                    "engagements": 250,
                    "clicks": 446,
                    "won": 40000
                },
                {
                    "reportDate": "2013-05-20",
                    "advertiserCode": "MERCHENTAFAKE",
                    "campaignCode": "MERCHENTAFAKE-test-campaign-1",
                    "publisher": "www.wp.pl",
                    "impressions": 20000,
                    "engagements": 125,
                    "clicks": 223,
                    "won": 20000
                },
                {
                    "reportDate": "2013-05-21",
                    "advertiserCode": "MERCHENTAFAKE",
                    "campaignCode": "MERCHENTAFAKE-test-campaign-1",
                    "publisher": "www.onet.pl",
                    "impressions": 20000,
                    "engagements": 125,
                    "clicks": 223,
                    "won": 20000
                }
            ]
        }
    }
  • Response  400
  • Response  404

All campaigns realtime report 

Gets the real-time data for all campaigns held by current advertiser account.

Note Shows data by hour for past period since midnight UTC. Hours go 00,01,02 etc from midnight UTC.

/v3/reporting/campaigns/realtime
  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/campaigns/realtime
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "hour": "2014-10-29T00:00:00.000",
                    "advertiserCode": "MERCHENTAFAKE",
                    "campaignCode": "MERCHENTAFAKE-test-campaign-1",
                    "auctions": 50000,
                    "bidsPlaced": 25000,
                    "won": 10000,
                    "impressions": 10000,
                    "clicks": 100,
                    "engagements": 50,
                    "winRate": 40,
                    "currencyCode": "TST",
                    "netMediaSpend": 800,
                    "grossMediaSpend": 1200,
                    "mediaMargin": 50,
                    "creatives": [
                        {
                            "creativeCode": "FBX-TEST-08-1",
                            "approvalStatus": "ACTIVE",
                            "auctions": 50000,
                            "bidsPlaced": 25000,
                            "won": 10000,
                            "impressions": 10000,
                            "clicks": 100,
                            "engagements": 50,
                            "winRate": 40,
                            "currencyCode": "TST",
                            "netMediaSpend": 800,
                            "grossMediaSpend": 1200,
                            "mediaMargin": 50
                        },
                        {
                            "creativeCode": "FBX-TEST-08-2",
                            "approvalStatus": "PENDING",
                            "auctions": 0,
                            "bidsPlaced": 0,
                            "won": 0,
                            "impressions": 0,
                            "clicks": 0,
                            "engagements": 0,
                            "winRate": 0,
                            "currencyCode": "TST",
                            "netMediaSpend": 0,
                            "grossMediaSpend": 0,
                            "mediaMargin": 0
                        }
                    ]
                },
                {
                    "hour": "2014-10-29T00:00:00.000",
                    "advertiserCode": "MERCHENTAFAKE",
                    "campaignCode": "MERCHENTAFAKE-test-campaign-2",
                    "auctions": 30000,
                    "bidsPlaced": 15000,
                    "won": 6000,
                    "impressions": 6000,
                    "clicks": 60,
                    "engagements": 30,
                    "winRate": 40,
                    "currencyCode": "TST",
                    "netMediaSpend": 480,
                    "grossMediaSpend": 720,
                    "mediaMargin": 50,
                    "creatives": [
                        {
                            "creativeCode": "FBX-TEST-08-1",
                            "approvalStatus": "ACTIVE",
                            "auctions": 30000,
                            "bidsPlaced": 15000,
                            "won": 6000,
                            "impressions": 6000,
                            "clicks": 60,
                            "engagements": 30,
                            "winRate": 40,
                            "currencyCode": "TST",
                            "netMediaSpend": 480,
                            "grossMediaSpend": 720,
                            "mediaMargin": 50
                        },
                        {
                            "creativeCode": "FBX-TEST-08-2",
                            "approvalStatus": "PENDING",
                            "auctions": 0,
                            "bidsPlaced": 0,
                            "won": 0,
                            "impressions": 0,
                            "clicks": 0,
                            "engagements": 0,
                            "winRate": 0,
                            "currencyCode": "TST",
                            "netMediaSpend": 0,
                            "grossMediaSpend": 0,
                            "mediaMargin": 0
                        }
                    ]
                }
            ]
        }
    }

Campaign realtime report 

Gets the real-time data for given campaign held by current advertiser account.

Note Shows data by hour for past period since midnight UTC. Hours go 00,01,02 etc from midnight UTC.

/v3/reporting/campaigns/{campaignCode}/realtime
  • Parameters
  • campaignCode
    string (required) Example: MERCHENTAFAKE-test-campaign-1

    The campaign code

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/campaigns/MERCHENTAFAKE-test-campaign-1/realtime
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "hour": "2014-10-29T00:00:00.000",
                    "advertiserCode": "MERCHENTAFAKE",
                    "campaignCode": "MERCHENTAFAKE-test-campaign-1",
                    "auctions": 50000,
                    "bidsPlaced": 25000,
                    "won": 10000,
                    "impressions": 10000,
                    "clicks": 100,
                    "engagements": 50,
                    "winRate": 40,
                    "currencyCode": "TST",
                    "netMediaSpend": 800,
                    "grossMediaSpend": 1200,
                    "mediaMargin": 50,
                    "creatives": [
                        {
                            "creativeCode": "FBX-TEST-08-1",
                            "approvalStatus": "ACTIVE",
                            "auctions": 50000,
                            "bidsPlaced": 25000,
                            "won": 10000,
                            "impressions": 10000,
                            "clicks": 100,
                            "engagements": 50,
                            "winRate": 40,
                            "currencyCode": "TST",
                            "netMediaSpend": 800,
                            "grossMediaSpend": 1200,
                            "mediaMargin": 50
                        },
                        {
                            "creativeCode": "FBX-TEST-08-2",
                            "approvalStatus": "PENDING",
                            "auctions": 0,
                            "bidsPlaced": 0,
                            "won": 0,
                            "impressions": 0,
                            "clicks": 0,
                            "engagements": 0,
                            "winRate": 0,
                            "currencyCode": "TST",
                            "netMediaSpend": 0,
                            "grossMediaSpend": 0,
                            "mediaMargin": 0
                        }
                    ]
                },
                {
                    "hour": "2014-10-29T00:00:00.000",
                    "advertiserCode": "MERCHENTAFAKE",
                    "campaignCode": "MERCHENTAFAKE-test-campaign-2",
                    "auctions": 30000,
                    "bidsPlaced": 15000,
                    "won": 6000,
                    "impressions": 6000,
                    "clicks": 60,
                    "engagements": 30,
                    "winRate": 40,
                    "currencyCode": "TST",
                    "netMediaSpend": 480,
                    "grossMediaSpend": 720,
                    "mediaMargin": 50,
                    "creatives": [
                        {
                            "creativeCode": "FBX-TEST-08-1",
                            "approvalStatus": "ACTIVE",
                            "auctions": 30000,
                            "bidsPlaced": 15000,
                            "won": 6000,
                            "impressions": 6000,
                            "clicks": 60,
                            "engagements": 30,
                            "winRate": 40,
                            "currencyCode": "TST",
                            "netMediaSpend": 480,
                            "grossMediaSpend": 720,
                            "mediaMargin": 50
                        },
                        {
                            "creativeCode": "FBX-TEST-08-2",
                            "approvalStatus": "PENDING",
                            "auctions": 0,
                            "bidsPlaced": 0,
                            "won": 0,
                            "impressions": 0,
                            "clicks": 0,
                            "engagements": 0,
                            "winRate": 0,
                            "currencyCode": "TST",
                            "netMediaSpend": 0,
                            "grossMediaSpend": 0,
                            "mediaMargin": 0
                        }
                    ]
                }
            ]
        }
    }
  • Response  404

Conversions report 

Gets conversions report the given advertiser between the supplied dates.

/v3/reporting/conversions/{advertiserCode}/{startDate}/{endDate}
  • Parameters
  • advertiserCode
    string (required) Example: MERCHNETA

    The advertiser ID

    startDate
    string (required) Example: 2014-09-01

    The start date

    endDate
    string (required) Example: 2014-09-14

    The end date

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/conversions/MERCHNETA/2014-09-01/2014-09-14
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
      "status": "success",
      "data": {
        "reports": [
          {
            "advertiserCode": "MERCHENTAFAKE",
            "conversionReference": "T157749",
            "conversionDateTime": "2011-10-02 10:02:17",
            "conversionIPAddress": "192.168.188.54",
            "mostRecentAd": "2011-09-23 19:27:41",
            "conversionType": "PV",
            "conversionInterval": 206.5767,
            "deviceFingerprint": "73e93cc7-ddc9-42cc-9bcd-8343e7640aa2",
            "adAuctionID": "OXae41f412-d9a9-4b51-9ab7-4b715be8038d",
            "adDomain": "http://fakedomain.com",
            "campaignCode": "CAMPAIGN-FAKE-CODE",
            "recommendationStrategy": "BestSellerRecommenderStrategy",
            "recommendedSKUs": "bgs6225gb",
            "recommendationObserved": "N",
            "recommendationEngaged": "Y",
            "conversionSKUs": "bgs6225gb,esvc125200",
            "SKUPrices": "172.99",
            "conversionValue": 172.99,
            "conversionCurrencyCode": "GBP",
            "conversionCountryCode": "US"
          },
          {
            "advertiserCode": "MERCHENTAFAKE",
            "conversionReference": "T15997749",
            "conversionDateTime": "2011-10-03 10:05",
            "conversionIPAddress": "192.168.188.54",
            "mostRecentAd": "2011-09-23 19:27:41",
            "conversionType": "PV",
            "conversionInterval": 206.5767,
            "deviceFingerprint": "73e93cc7-ddc9-42cc-9bcd-8343e7640aa2",
            "adAuctionID": "OXae41f412-d9a9-4b51-9ab7-4b715be8038d",
            "adDomain": "http://fakedomain.com",
            "campaignCode": "CAMPAIGN-FAKE-CODE",
            "recommendationStrategy": "BestSellerRecommenderStrategy",
            "recommendedSKUs": "bgs6225gb",
            "recommendationObserved": "N",
            "recommendationEngaged": "Y",
            "conversionSKUs": "bgs6225gb,esvc125200",
            "SKUPrices": "172.99",
            "conversionValue": 172.99,
            "conversionCurrencyCode": "GBP",
            "conversionCountryCode": "US"
          }
        ]
      }
    }
  • Response  400
  • Response  404

Conversion detail report 

Gets conversion detail report the given advertiser and reference.

/v3/reporting/conversions/{advertiserCode}/{conversionReference}
  • Parameters
  • advertiserCode
    string (required) Example: MERCHNETA

    The advertiser ID

    conversionReference
    string (required) Example: T157749

    The conversion reference

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/conversions/MERCHNETA/T157749
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
      "status": "success",
      "data": {
        "reports": [
          {
            "advertiserCode": "MERCHENTAFAKE",
            "conversionReference": "T157749",
            "conversionDateTime": "2011-10-02 10:02:17",
            "conversionIPAddress": "192.168.188.54",
            "mostRecentAd": "2011-09-23 19:27:41",
            "conversionType": "PV",
            "conversionInterval": 206.5767,
            "deviceFingerprint": "73e93cc7-ddc9-42cc-9bcd-8343e7640aa2",
            "adAuctionID": "OXae41f412-d9a9-4b51-9ab7-4b715be8038d",
            "adDomain": "http://fakedomain.com",
            "campaignCode": "CAMPAIGN-FAKE-CODE",
            "recommendationStrategy": "BestSellerRecommenderStrategy",
            "recommendedSKUs": "bgs6225gb",
            "recommendationObserved": "N",
            "recommendationEngaged": "Y",
            "conversionSKUs": "bgs6225gb,esvc125200",
            "SKUPrices": "172.99",
            "conversionValue": 172.99,
            "conversionCurrencyCode": "GBP",
            "conversionCountryCode": "US"
          }
        ]
      }
    }
  • Response  400
  • Response  404

Segment members statistics report 

Gets the segment members statistics report for given advertiser and date.

/v3/reporting/segments/{advertiserCode}/{reportDate}
  • Parameters
  • advertiserCode
    string (required) Example: MERCHENTA

    The advertiser code

    reportDate
    string (required) Example: 2014-10-20

    The report date

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/segments/MERCHENTA/2014-10-20
  • Response  200
  • Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "reportDate": "2014-10-20",
                    "segmentId": "mta101",
                    "segmentType": "EMAIL_OPEN",
                    "advertiserCode": "MERCHENTA",
                    "today": {
                        "additions": 0,
                        "removals": 0
                    },
                    "weekToDate": {
                        "additions": 0,
                        "removals": 0
                    },
                    "monthToDate": {
                        "additions": 1,
                        "removals": 0
                    },
                    "previousMonth": {
                        "additions": 14,
                        "removals": 0
                    },
                    "allTimeToDate": {
                        "additions": 192,
                        "removals": 1
                    }
                },
                {
                    "reportDate": "2014-10-20",
                    "segmentId": "nhf04ej",
                    "segmentType": "VIEW",
                    "advertiserCode": "MERCHENTA",
                    "today": {
                        "additions": 1,
                        "removals": 0
                    },
                    "weekToDate": {
                        "additions": 1,
                        "removals": 0
                    },
                    "monthToDate": {
                        "additions": 1,
                        "removals": 0
                    },
                    "previousMonth": {
                        "additions": 10,
                        "removals": 1
                    },
                    "allTimeToDate": {
                        "additions": 11,
                        "removals": 1
                    }
                }
            ]
        }
    }
  • Response  200
  • Example body
    {
        "status": "success",
        "data": {
            "reports": []
        }
    }
  • Response  400
  • Example body
    {
        "status": "fail",
        "data": {
            "errors": [
                {
                    "code": "ER20003",
                    "description": "Only historical dates are supported"
                }
            ]
        }
    }

S2S report with event type 

Gets the S2S report for given advertiser and dates and event type.

/v3/reporting/app/{advertiserCode}/{startDate}/{endDate}/{eventType}
  • Parameters
  • advertiserCode
    string (required) Example: MERCHENTA

    The advertiser code

    startDate
    string (required) Example: 2014-10-20

    The report date

    endDate
    string (required) Example: 2014-10-20

    The report date

    eventType
    string (required) Example: INSTALL

    The event type. Possible: INSTALL, REGISTRATION, PURCHASE or SESSION

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/app/MERCHENTA/2014-10-20/2014-10-20/INSTALL
  • Response  200
  • Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "auctionId": "2",
                    "eventType": "INSTALL",
                    "thirdPartyTrackingId": null,
                    "thirdPartySubId": null,
                    "thirdPartyEventId": null,
                    "thirdPartyCampaignId": null,
                    "campaignCode": null,
                    "creativeCode": null,
                    "reportDate": "2015-10-26T02:17:16.000",
                    "idfa": null,
                    "androidId": null,
                    "country": null,
                    "revenue": null,
                    "currency": null,
                    "url": null,
                    "advertiserCode": "MERCHENTA",
                    "adShown": null
                }
            ]
        }
    }

S2S report without event type 

Gets the S2S report for given advertiser and dates.

/v3/reporting/app/{advertiserCode}/{startDate}/{endDate}
  • Parameters
  • advertiserCode
    string (required) Example: MERCHENTA

    The advertiser code

    startDate
    string (required) Example: 2014-10-20

    The report date

    endDate
    string (required) Example: 2014-10-20

    The report date

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/reporting/app/MERCHENTA/2014-10-20/2014-10-20
  • Response  200
  • Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "auctionId": "2",
                    "eventType": "INSTALL",
                    "thirdPartyTrackingId": null,
                    "thirdPartySubId": null,
                    "thirdPartyEventId": null,
                    "thirdPartyCampaignId": null,
                    "campaignCode": null,
                    "creativeCode": null,
                    "reportDate": "2015-10-26T02:17:16.000",
                    "idfa": null,
                    "androidId": null,
                    "country": null,
                    "revenue": null,
                    "currency": null,
                    "url": null,
                    "advertiserCode": "MERCHENTA",
                    "adShown": null
                },
                {
                    "auctionId": "4",
                    "eventType": "REGISTRATION",
                    "thirdPartyTrackingId": null,
                    "thirdPartySubId": null,
                    "thirdPartyEventId": null,
                    "thirdPartyCampaignId": null,
                    "campaignCode": null,
                    "creativeCode": null,
                    "reportDate": "2015-10-26T02:17:52.000",
                    "idfa": null,
                    "androidId": null,
                    "country": null,
                    "revenue": null,
                    "currency": null,
                    "url": null,
                    "advertiserCode": "MERCHENTA",
                    "adShown": null
                }
            ]
        }
    }
Next page  Previous page