Insights Service API (Node)
Available Metrics
POSTGet search data
GETGet the insights available for an audience
Load Metrics
POSTLoad audience insight metrics

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

Server Variables

Get search data

Auth
Request Body

Get the

objectobject
metricsarray[string]

minLength: 1

audience_idstring
account_idstring
product_idstring
start3 fieldsobject
end3 fieldsobject
POST /audience/insights/search
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

objectobject
activeboolean
response2 fieldsarray[object]
400

Bad Request

Response
{
"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_idstring
account_idstring
product_idstring
GET /audience/insights/metrics
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

objectobject
activeboolean
response6 fieldsarray[object]
400

Bad Request

Response
{
"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

Auth
Request Body
objectobject
metricstring
audience_idstring
history2 fieldsarray[object]
POST /audience/insights/metrics
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
No response
Copy

We serve cookies on this site to analyse traffic and optimise your experience. By using the website you agree to the Privacy Policy.