Skip to end of metadata
Go to start of metadata

The Wrapper Pulse API is accessed via https://pulse.indexexchange.com/api through two different routes, each representing a different type of data. Global routes retrieve global bidder stats, while country-based routes retrieve country-based bidder stats. 

Pulse accepts a standard set of request parameters, and returns a variety of different response parameters based on the type of data requested. There are a few possible error messages in the mix too. 

To dive deeper, you can walk through several common reporting scenarios using examples of API calls and responses. 

Global Routes 


The following routes may be queried for global data:

Route

Description

/islive

Returns a response that confirms the API is up and running. This route is unauthenticated and can be used as verification.

/stats/latency/hourly

Retrieves hourly bidder latency values, divided into latency buckets based on bidder response time.

/stats/latency/daily

Retrieves daily bidder latency values, divided into latency buckets based on bidder response time.

/stats/bidvolume/hourly

Retrieves hourly bid volume values, including total counts for each of the following metrics: bid request, eligible bids, error, timeout, passes.

/stats/bidvolume/daily

Retrieves daily bid volume values, including total counts for each of the following metrics: bid request, eligible bids, error, timeout, passes.

Country-based Routes 


The following routes may be queried for country-based data:

Route

Description

/islive

Returns a response that confirms the API is up and running. This route is unauthenticated and can be used as verification.

/v2/stats/latency/hourly

Retrieves hourly bidder latency values, divided into latency buckets based on bidder response time. Values are sorted by country.

/v2/stats/latency/daily

Retrieves daily bidder latency values, divided into latency buckets based on bidder response time. Values are sorted by country.

/v2/stats/bidvolume/hourly

Retrieves hourly bid volume values, including total counts for each of the following metrics: bid request, eligible bids, error, timeout, passes. Values are sorted by country.

/v2/stats/bidvolume/daily

Retrieves daily bid volume values, including total counts for each of the following metrics: bid request, eligible bids, error, timeout, passes. Values are sorted by country.

Request Parameters 


Each route described above accepts the exact same set of parameters and validation described below.  

Parameter

Data Type

Validation

Description


period

Required

Integer

The length of time the report should cover. Hourly reports are requested in hours; daily reports are requested in days. Both routes may specify any start point.

Note: Hourly aggregations are capped at 24 hours of data, while daily aggregations are capped at 90 days of data.

start

Required

Integer

The UNIX timestamp of the date the report should start from. Queries for hourly reports may indicate any arbitrary time, e.g. 1486940400.

userID

Required

Integer

Your publisher ID.

siteIDs

Optional

CSV list of integers

A list of the specific sites the report should cover. If omitted, we’ll send data for all sites.

tz

Optional

String

A valid timezone string, e.g.  "America/Los_Angeles" .


Response Parameters 


Each route described above returns a combination of parameters described below within one or more JSON objects, depending on the type of reporting data queried.

Country-based Data

The following parameters are included when country-based bid data is requested:

Parameter

Data Type

Description

date

Integer

The date that the report data pertains to, formatted according to  ISO-8601 Date and time format.   Hourly reports additionally include the time, e.g. 1486940400.

partnerEntries

Array of objects

One or more additional objects containing the bidder data requested.

partnerEntries Object (Bid Latency Data)

The following parameters are included in the partnerEntries object when country-based bid latency data is requested:

Parameter

Data Type

Description

partner

String

An identifier representing the bidder, e.g. "INDX".

perCountry

Array of objects

One or more objects representing country-based bid latency buckets.

perCountry Object (Bid Latency Data)

The following parameters are included the perCountry object when country-based bid latency data is requested:

Parameter

Data Type

Description

country

String

A two character identifier representing the country, e.g. "CA".

"XX" indicates that no country was specified.

values

Array of integers

The number of occurrences in each latency bucket for the given country. There are 15 buckets in total, each representing 100ms (the 15th bucket represents 1400ms+), e.g. [15, 100, 20, 35, ..., 11]

partnerEntries Object (Bid Volume Data)

The following parameters are included in the partnerEntries object when country-based bid volume data is requested:

Parameter

Data Type

Description

partner

String

An identifier representing the bidder, e.g. "INDX".

perCountry

Array of objects

An additional object, containing bid volume values.

Bid Volume perCountry Object (Bid Volume Data)

The following parameters are included the perCountry object when country-based bid volume data is requested:

Parameter

Data Type

Description

country

String

A two character identifier representing the country, e.g. "CA".

"XX" indicates that no country was specified.

values

Array of integers

An object containing a variety of bid volume data for the given country. 

Bid Volume values Object (Bid Volume Data)

The following parameters are included in the values object when country-based bid volume data is requested:

Parameter

Data Type

Description

err

Integer

The number of bids submitted that resulted in an error.

pass

Integer

The number of bid passes submitted.

res

Integer

The number of eligible bids submitted.

req

Integer

The number of bid requests sent.

timeout

CSV list of integers

The number of times the bidder timed out.

Global Data

The following parameters are included when global bid data is requested:

Parameter

Data Type

Description

date

String

The date that the report data pertains to, formatted according to  ISO-8601 Date and time format.   Hourly reports additionally include the time, e.g. 1486940400.

partnerEntries

Array of objects

One or more additional objects containing the bidder data requested.

partnerEntries Object (Bid Latency Data)

The following parameters are included in the partnerEntries object when global bid latency data is requested:

Parameter

Data Type

Description

partner

String

An identifier representing the bidder, e.g. "INDX".

values

Array of integers

The number of occurrences in each latency bucket for the given country. There are 15 buckets in total, each representing 100ms (the 15th bucket represents 1400ms+), e.g. [15, 100, 20, 35, ..., 11].

partnerEntries Object (Bid Volume Data)

The following parameters are included in the partnerEntries object when global bid latency data is requested:

Parameter

Data Type

Description

partner

String

An identifier representing the bidder, e.g. "INDX".

perCountry

Object

An additional object, containing bid volume values.

Bid Volume values Object (Bid Volume Data)

The following parameters are included in the values object when global bid volume data is requested:

Parameter

Data Type

Description

err

Integer

The number of bids submitted that resulted in an error.

pass

Integer

The number of bid passes submitted.

res

Integer

The number of eligible bids submitted.

req

Integer

The number of bid requests sent.

timeout

CSV list of integers

The number of times the bidder timed out.

Feedback

  • No labels