Knowledge Base

Reporting API

Overview

  1. This documentation describes how to pull data from Browsi’s Dashboard in a programmatic matter.
  2. The same data will be returned to the user either in Browsi Dashboard UI or when using the API.
  3. Only reporting data is available via API. Engagement, Inventory, Device data is available via the UI.
  4. Data is aggregated by day.
  5. Data for the previous day will be available each day at 09:00 AM EST.
  6. Users are required to perform authentication before requesting data from the API.

End-Points

Reports

Authentication

  • Before each reporting request is made, publishers need to provide authentication.
  • Send a request to the Login end-point, and use the cookies returned from the server to request the reports.

Login

URL – https://flavius-server.gobrowsi.com/login

Method – POST

Example (Body) –

{
"username" "demo@gobrowsi.com",
"password" "12345678"
}

Expected response –

  • HTTP 200 – successful login
  • HTTP 400 – bad credentials

Reports – how to make a request?

URL – https://flavius-server.gobrowsi.com/api/report

Method – GET

Parameters:

Parameter
Description
Valid Input
Example
Notes
startDate The requested start date of the report.
  • Date no late then Yesterday.
  • Format – YYYY-MM-DD
2017-02-12 Latest data available is yestarday, as of 09AM of the current day.
endDate The requested end date of the report.
  • Date no late then Yesterday.
  • Format – YYYY-MM-DD
2017-02-14 Latest data available is yestarday, as of 09AM of the current day.
siteKey The requested publisher site.
  • A single valid site key, associated with your publisher id.
  • String.
DEMO_SITE A list of all available sites can be found in Browsi dashboard UI under your account, If you do not know your site key options, Please consult with your account manager.

Reports – what does a response look like?

  1. Per request – a response in the form of a JSON object will be returned to the user.
  2. The JSON will consist of 3 keys in the top level:
  • items – Contains a list of the entire data.
  • count – The count of the units in the items list.
  • total – Total amount of records available.
  1. Data will be returned per day, per country (one object for each day request multiplied by the countries).
  2. Days / Countries with no data will not be returned in the response.

Example: Single Day / Country object:

Key
Value description
Value example
Notes
Date A single day, format – YYYY-MM-DD. 2017-02-15
Country a single country in the form of country code. usuk
Site a valid site key. DEMO_SITE Since it’s a parameter will be the same across the board.
Traffic source A single traffic source, either one of the following – Default, Social, Search – See notes. ALL Coming soon feature – Currently will be returned as “ALL” to all objects returned.Default = Direct.
publisherPv Total amount of pageviews Browsi was embedded successfully on from a specific site. per day, country & traffic source. 12205 Includes both monetized & Benchmark pageviews.
monetizedPv Total amount of pageviews Browsi’s engine monetized successfully from a specific site. per day, country & traffic source. 10025
adRequest Total amount of ad requests Browsi’s engine sent in order to get an impression from a specific site. per day, country & traffic source. 100000
impressions Total amount of impressions Browsi’s engine embedded successfully on a specific site. per day, country & traffic source. 50000
fillRate The total percentage of impressions embedded out of the amount of ad requests sent (Integer). 50
viewabilityRate The rate of impressions that were considered viewable by Browsi engine out of the total impressions (Decimal number representing percentage). 0.822253 Viewable impression = impressions that was viewed by the user for at least 1 second and was located that time in at least 50% of the user view-port.

Example Response:

{
  "items": [
    {
      "date""2017-03-24",
      "country""us",
      "site""DEMO_SITE",
      "trafficSource""ALL",
      "publisherPv": 14546,
      "monetizedPv": 7057,
      "adRequest": 12,
      "impressions": 12,
      "fillRate": 100,
      "viewabilityRate": 0.998966666444
    },
    {
      "date""2017-03-24",
      "country""nl",
      "site""DEMO_SITE",
      "trafficSource""ALL",
      "publisherPv": 2,
      "monetizedPv": 2,
      "adRequest": 5,
      "impressions": 5,
      "fillRate": 100,
      "viewabilityRate": 0.800000011920929
    },
    {
      "date""2017-03-24",
      "country""mx",
      "site""DEMO_SITE",
      "trafficSource""ALL",
      "publisherPv": 2,
      "monetizedPv": 2,
      "adRequest": 5,
      "impressions": 5,
      "fillRate": 100,
      "viewabilityRate": 0.20000000298023224
    }
  ],
  "total": 10,
  "count": 10
}

Demo account

Users who wish to test the API are free to use the demo account, which will return demo data.

Username – demo@gobrowsi.com

Password – 12345678