Insights Service API (Node)1.0.0

Insights Service API implemented in NodeJS

Servers

Choose a server to use:

/api/v1

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

production server

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

test server

Available Metrics

Get search data

POST /audience/insights/search

Auth

Request Body

Get the

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

Example Request

​x
 
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 400

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

Example Response

200 List of audience insights

400 Bad Request

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

GET /audience/insights/metrics

Auth

Query String

audience_id	string	required
account_id	string	required
product_id	string	required

Example Request

xxxxxxxxxx
 
curl --request GET \ --url /api/v1/audience/insights/metrics?audience_id={audience_id}&account_id={account_id}&product_id={product_id}
Copy

Responses

200 400

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

Example Response

200 List of available metrics

400 Bad Request

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

Load audience insight metrics

POST /audience/insights/metrics

Auth

Request Body

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

Example Request

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 400

No response body

Example Response

204 Metrics Loaded

400 Bad Request

xxxxxxxxxx
 
No response
Copy