RevX Reporting API

Steps

  1. Generate auth token using username and password; store the token generated. Token expires 24 hours after the last usage.
  2. Export CSV report by making a call to API endpoint with the auth token from step #1.

1. Auth Token Request:

URL: https://urgv2.atomex.net/v2/auth/login

Payload: 

{
  "username": "testmail@revx.io",
   "password": "md5(text password)"
}

Method: POST

Response:

{
  "respObject": 
{
 "username": "testmail@revx.io",

"token":
"eyJhbGciOiJIUzI1NiIsInppcCI6IkRFRiJ9.eNpsjs9Kw0AQh1-lzDkU21Dk5OgBgLxD7l4cIusmymOxiTsbkKl5O7FV_ABPAu-Tk8-R2cb68nLMnzz--03W7DdAySwrqh9VsZNqT42G-m1EAAVjctWl4X1_nFfXHLiJSDJFwsZyfxIoriAHDTjiAMxQE8OeKG7M6Xc8Fvmsa7r--fj_fd55vvW__fVkJn0WSlhGQ-iwIJqnOPjSFHaJndyaNSwioYw7V6QV7J_26VwCGLFWqHZU4aa4s-zB7dGYO1fj1ryrGeXRWHuNKOeo_WqrLIgPw1QvD0p0p_VZOsLklNbno3yR3HBt8v-6PpUrWjTAh__GoYYNgDAAD__w.gtsj0nv9TD6Sg1qlv1DFvsMARaxQxwCOF-AbIRfjXc8",

"masterToken":
"eyJhbGciOiJIUzI1NiIsInppcCI6IkRFRiJ9.eNpskM9Kw0AQh18lzDkU9jQ5KS0FgJBJRcPrsi6meJo3IT9EyqlB9_AZ5A-gI9k38RZo556WZZvvt-Pnd2C9Q9QwLql_lkaNy9ZnDYTKiDGKzqerQ8rq-qi_v6hhFJB0Uym09P8lmW5THgph9BkqQ_4MkRJ77274f9m_DLeZbzuTxfHT4-Q96Gvq0Ab9GUjYDidJrFAiy2qBw2FSnUFpEHLClvDGr1uuiaQASUl7UA1qVyNAS0lq1FBhSq0pRvWr6M7up3p6jUDcnoenBR5Vjbhbx3j50hR2jZvRV_Gwq4i8e3_dcc-RrugN03AAAA__8.OYR4r6OgSUDADzmof0Kw-pX1fVSmNX4lshi4PPDq03A"

},

"respId": "82NHonS5h4t7h98U1WEiUXZmETdUbg3D",

"error": null

}

"token" is the authentication key. It is mandatory to pass in all other Other API's header for the authentication.

Report Requests:

  1. Report Data Request:

URL: https://apiv2.atomex.net/v2/api/performance/rtb

Method: POST

Header: token: <auth token> 

Payload: 

{
   "columns": [
       "impressions",
       "clicks",
       "invalid_clicks",
       "total_install",
       "imp_installs"
   ],
   "interval": "daily",
   "duration": {
       "start_timestamp": 1590710400,
       "end_timestamp": 1591315200
   },
   "currency_of": "licensee",
   "filters": [],
   "page_size": 50,
   "page_number": 1,
   "sort_by": [],
   "group_by": [
       "campaign",
       "strategy",
       "creative",
       "country"
   ]
}

Response:

{
   "respObject": {
       "results": [
           {
               "starttime": "2020-06-04 00:00:00.0",
               "creative": {
                   "name": "30Aug Non-NCFK Native DCO with FB_1",
                   "id": "91733"
               },
               "imp_installs": 0,
               "strategy": {
                   "name": "Others Cart R01 Native High CPA 280 F18",
                   "id": "39536",
                   "type": "standard",
                   "pricing_id": "3",
                   "status": "0"
               },
               "total_install": 0,
               "licensee": {
                   "name": "Flipkart India Pvt Ltd",
                   "id": "33"
               },
               "invalid_clicks": 0,
               "endtime": "2020-06-04 23:59:59.0",
               "impressions": 0,
               "campaign": {
                   "sales_manager_id": "4440",
                   "name": "Flipkart RT Main Campaign",
                   "id": "13055",
                   "status": "1"
               },
               "country": {
                   "name": "India",
                   "id": "100"
               },
               "clicks": 1,
               "currency": {
                   "code": "INR",
                   "name": "Indian Rupee",
                   "id": "73"
               }
           },
       ],
       "total_results_count": 5409,
   },
   "respId": "564634339",
   "error": null
}

Report Data Export Request

URL: https://apiv2.atomex.net/v2/api/performance/rtb.csv

Method: POST

Header: token: <auth token> 

Payload: 

{
   "columns": [
       "impressions",
       "clicks",
       "invalid_clicks",
       "total_install",
       "imp_installs"
   ],
   "interval": "daily",
   "duration": {
       "start_timestamp": 1590710400,
       "end_timestamp": 1591315200
   },
   "currency_of": "licensee",
   "filters": [],
   "page_size": 50,
   "page_number": 1,
   "sort_by": [],
   "group_by": [
       "campaign",
       "strategy",
       "creative",
       "country"
   ]
}

Response:

{
   "respObject": {
       "fileName": "report_rtb_29_05_2020_05_06_2020_334276502_1591348459.csv",
       "fileDownloadUrl":     "https://download.atomex.net/report_rtb_29_05_2020_05_06_2020_334276502_1591348459.csv"
   },
   "respId": "pTiW2dHrTg3x5e8piRoiJOiMmWmBZ9mq",
   "error": null
}

Appendix:
Group By Columns:
Key Description
advertiser Advertiser ID & Name
campaign Campaign ID & Name
strategy Ad Group ID & Name
creative Ad ID & Name
country Country ID & Name
aggregator Ad Exchange eg. Google, Mopub, etc.
domain Website/Mobile app ID & Name
Mobile app ID- RevX internal app ID
Mobile app Name- Android package name or iOS App ID
os 4=Android, 3=iOS
source_type Desktop web, Mobile web or Mobile app

Interval

Interval Valid Time Duration
None 12 months
monthly 12 months
daily 6 months
hourly 30 days
Did this answer your question? Thanks for the feedback There was a problem submitting your feedback. Please try again later.