Does Bright SDK dashboard offer reports API?

  • Updated

 

Yes, we currently offer a reporting API , which allows you to integrate the revenue data into your own workflow and internal BI systems, perform automated analytics, etc.

See the full guide below for details.

 

Bright SDK Public API



Prerequisites

Base API endpoint

Authorization

Methods

Apps list

Revenue report

Revenue report by country

Revenue report by campaign

 

 

Prerequisites

  1. Get API access from your Bright SDK manager
  2. Create API key at your company profile page (this can be done by the company admin user):

 

Base API endpoint

https://bright-sdk.com/api

 

Authorization

Provide "api-key" header with value of given API key

 

Example:

 

const request_headers = {

...

"api-key": "z4lokwymtiueehzimrdgogvpucrbzhmz",

};

Methods

Apps list

 

Method GET
Path /apps

 

Return value

Field Type
name string
os string
uuid string



Example output:

 

[{


   name: "App name I",

   os: "ios",

   appid: "ios_app_name_1",

   uuid: "udf9fdfwpxvucvj3"

}, {

   name: "App name II",

   os: "ios",

   appid: "ios_app_name_2",

   uuid: "ucf2fdfwsxducvj1"

}]

 

Revenue report

Method GET
Path /reports/basic

 

Params

Name Type Example
app_uuid string (optional) ucf2fdfwsxducvj1
month string (optional) 2023-10
date string (optional) 2023-10-30

 

Example request:

https://bright-sdk.com/api/reports/basic?app_uuid=ucf2fdfwsxducvj1&month=2023-10

 

Example output:

[

  {ymd: "2023-12-01", earnings: 5, peers: 230},

  {ymd: "2023-12-02", earnings: 8, peers: 460},

  {ymd: "2023-12-03", earnings: 3, peers: 450}

]

 

Possible error answers:

{error: "Invalid date"}



Revenue report by country

Method GET
Path /reports/basic/by_country

 

Params

Name Type Example
app_uuid string (optional) ucf2fdfwsxducvj1
month string (optional) 2023-10
date string (optional) 2023-10-30

 

Example request:

https://bright-sdk.com/api/reports/basic/by_country?app_uuid=ucf2fdfwsxducvj1&month=2023-10

 

Example output:

[

  {ymd: "2023-12-01", records: [

    {earnings: 161.5, peers: 48940, country: "vn"},

    {earnings: 120.5, peers: 31000, country: "us"}

  ]},

  {ymd: "2023-12-02", records: [

    {earnings: 141.5, peers: 42940, country: "de"},

    {earnings: 110.5, peers: 29000, country: "us"}

  ]},

  {ymd: "2023-12-03", records: [

    {earnings: 121.5, peers: 38940, country: "kr"},

    {earnings: 100.5, peers: 11000, country: "us"}

  ]}

]

 

Possible error answers:

{error: "Invalid date"}

 

Revenue report by campaign

Method GET
Path /reports/basic/by_campaign

 

Params

Name Type Example
app_uuid string (optional) ucf2fdfwsxducvj1
month string (optional) 2023-10
date string (optional) 2023-10-30

 

Example request:

https://bright-sdk.com/api/reports/basic/by_campaign?app_uuid=ucf2fdfwsxducvj1&month=2023-10

 

Example Output:

[

  {ymd: "2023-12-01", records: [

    {earnings: 161.5, peers: 48940, campaign: "promo"},

    {earnings: 120.5, peers: 31000, campaign: "promo2"}

  ]},

  {ymd: "2023-12-02", records: [

    {earnings: 141.5, peers: 42940, campaign: "promo"},

    {earnings: 110.5, peers: 29000, campaign: "promo2"}

  ]},

  {ymd: "2023-12-03", records: [

    {earnings: 121.5, peers: 38940, campaign: "promo2"},

    {earnings: 100.5, peers: 11000, campaign: "promo"}

  ]}

]