RTB API

Using merchenta.io for real-time bidding

Media Planning 

Our platform provides detail about what inventory/impressions are available by various criteria. E.g. “How many impression are there for 728x90 units in UK per month?”. The following methods give reports of number of available impressions in a specific time span:

  • Number of impressions grouped by domain
  • Number of impressions grouped by domain and device
  • Number of impressions grouped by geographic location (e.g. UK, US)
  • Number of impressions grouped by device type (e.g. MOBILE, TABLET)

Grouped by domain 

Retrieve list of domains in inventories, GEOs and AD units for the period between [startDate] and [endDate]

Note [startDate] must be same as or after [endDate]. Period must be maximum of 90 days.

/v3/planning/domains/{startDate}/{endDate}
  • Parameters
  • 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/planning/domains/2014-09-01/2014-09-14
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "domain": "merchenta.com",
                    "impressions": 4000
                },
                {
                    "domain": "ebay.com",
                    "impressions": 5000
                }
            ]
        }
    }
  • Response  400
  • Response  404

Grouped by domain and device 

Retrieve list of domains in inventories, GEOs and AD units for the period between [startDate] and [endDate] for specified device type.

Note [startDate] must be same as or after [endDate]. Period must be maximum of 90 days.

/v3/planning/domains/{startDate}/{endDate}/{device}
  • Parameters
  • startDate
    string (required) Example: 2014-09-01

    The start date

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

    The end date

    device
    string (required) Example: MOBILE

    devices: MOBILE, DESKTOP, SLATE, CONSOLE, TV and WEARABLE

  • Curl
  • Copy
    curl -i \ -X GET \ -H 'Authorization: Bearer {YOUR_TOKEN_HERE}' \ https://sandbox.rtbapi.io/v3/planning/domains/2014-09-01/2014-09-14/MOBILE
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "domain": "merchenta.com",
                    "impressions": 4000,
                    "deviceType":"MOBILE",
                    "mediaType":"banner"
                },
                {
                    "domain": "ebay.com",
                    "impressions": 5000,
                    "deviceType":"SLATE",
                    "mediaType":"video"
                }
            ]
        }
    }
  • Response  400
  • Response  404

Grouped by Geo 

Retrieve number of impressions, domain, device type, media type grouped by geography for the period between [startDate] and [endDate].

Note [startDate] must be same as or after [endDate]. Period must be maximum of 90 days.

/v3/planning/geos/{startDate}/{endDate}
  • Parameters
  • 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/planning/geos/2014-09-01/2014-09-14
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "geo": "merchenta.com",
                    "impressions": 4000,
                    "unitSize":"200x300",
                    "mediaType":"banner",
                    "deviceType":"MOBILE"
                },
                {
                    "domain": "ebay.com",
                    "impressions": 5000,
                    "unitSize":"320x50",
                    "mediaType":"video",
                    "deviceType":"SLATE"
                }
            ]
        }
    }
  • Response  400
  • Response  404

Inventory report - Grouped by devices 

Retrieve number of impressions, domain, unit type, media type grouped by device type for the period between [startDate] and [endDate].

Note [startDate] must be same as or after [endDate]. Period must be maximum of 90 days.

/v3/planning/geos/{startDate}/{endDate}
  • Parameters
  • 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/planning/geos/2014-09-01/2014-09-14
  • Response  200
  • Headers
    Content-Type: application/json
    Example body
    {
        "status": "success",
        "data": {
            "reports": [
                {
                    "deviceType": "merchenta.com",
                    "impressions": 4000,
                    "unitSize":"320x50",
                    "mediaType":"banner"
                },
                {
                    "domain": "ebay.com",
                    "impressions": 5000,
                    "unitSize":"300x200",
                    "mediaType":"video"
                }
            ]
        }
    }
  • Response  400
  • Response  404
Next page  Previous page