Insights Service API (Node) 1.0.0

Insights Service API implemented in NodeJS

Server

/api/v1

https://insights-prod.adara.com/api/v1

production server

https://insights-qa.adara.com/api/v1

test server

Available Metrics

POST

/audience/insights/search

GET

/audience/insights/metrics

Get search data

Auth

Request Body

Get the

object	object
metrics	array[string]	minLength: 1
audience_id	string
account_id	string
product_id	string
start	object
year	integer	maximum: 2100 minimum: 2019
month	integer	maximum: 12 minimum: 1
day	integer	maximum: 31 minimum: 1
end	object
year	integer	maximum: 2100 minimum: 2019
month	integer	maximum: 12 minimum: 1
day	integer	maximum: 31 minimum: 1

POST /audience/insights/search

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1/audience/insights/search' \ --data '{  "metrics": [    "{array[string]...}"  ],  "audience_id": "{string}",  "account_id": "{string}",  "product_id": "{string}",  "start": {    "year": "{integer}",    "month": "{integer}",    "day": "{integer}"  },  "end": {    "year": "{integer}",    "month": "{integer}",    "day": "{integer}"  }}'
Copy

Responses

200

List of audience insights

object	object
active	boolean
response	array[object]
name	string
history	array[object]
date	string
values	array[object]
name	string
display_name	string
value	number

400

Bad Request

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "name": "trip_frequency",   "history": [    {     "date": "2019-04-11T00:00:00.000Z",     "values": [      {       "name": "{string}",       "display_name": "{string}",       "value": "{number}"      }     ]    }   ]  } ]}
Copy

Get the insights available for an audience

Auth

Query String

audience_id	string
account_id	string
product_id	string

GET /audience/insights/metrics

xxxxxxxxxx
 
curl --get \ --url '/api/v1/audience/insights/metrics' \ --data audience_id={audience_id} \ --data account_id={account_id} \ --data product_id={product_id}
Copy

Responses

200

List of available metrics

object	object
active	boolean
response	array[object]
metric	string
positive_direction	integer	Enum: `-1`,`0`,`1`
display_name	string
first_available	string
last_available	string
unit	string

400

Bad Request

Response

xxxxxxxxxx
 
{ "active": "{boolean}", "response": [  {   "metric": "tvs_breakdown",   "positive_direction": "{integer}",   "display_name": "Value",   "first_available": "2019-07-03T00:00:00.000Z",   "last_available": "2019-09-03T00:00:00.000Z",   "unit": "$"  } ]}
Copy

Load Metrics

POST

/audience/insights/metrics

Load audience insight metrics

Auth

Request Body

object	object
metric	string
audience_id	string
history	array[object]
date	object
year	integer	maximum: 2100 minimum: 2019
month	integer	maximum: 12 minimum: 1
day	integer	maximum: 31 minimum: 1
value	object

POST /audience/insights/metrics

xxxxxxxxxx
 
curl --request POST \ --url '/api/v1/audience/insights/metrics' \ --data '{  "metric": "{string}",  "audience_id": "{string}",  "history": [    {      "date": {        "year": "{integer}",        "month": "{integer}",        "day": "{integer}"      },      "value": {}    }  ]}'
Copy

Responses

204

Metrics Loaded

No response body

400

Bad Request

Response

xxxxxxxxxx
 
No response
Copy