Qodex.ai

Get user account analytics

GET {{baseUrl}}/user_account/analytics?start_date=1977-03-23&end_date=1977-03-23&from_claimed_content=BOTH&pin_format=ALL&app_types=ALL&metric_types=ENGAGEMENT_RATE,OUTBOUND_CLICK&split_field=NO_SPLIT&ad_account_id=55846658

Get analytics for the operation user_account - By default, the operation user_account is the token user_account.

Optional: Business Access: Specify an adaccountid to use the owner of that adaccount as the "operation useraccount".

Request Params

KeyDatatypeRequiredDescription
start_datestring(Required) Metric report start date (UTC). Format: YYYY-MM-DD
end_datestring(Required) Metric report end date (UTC). Format: YYYY-MM-DD
from_claimed_contentstringFilter on Pins that match your claimed domain.
pin_formatstringPin formats to get data for, default is all.
app_typesstringApps or devices to get data for, default is all.
metric_typesstringMetric types to get data for, default is all.
split_fieldstringHow to split the data into groups. Not including this param means data won't be split.
ad_account_idnumberUnique identifier of an ad account.

HEADERS

KeyDatatypeRequiredDescription
Acceptstring

RESPONSES

status: OK

{"adipisicingcc":{"daily_metrics":[{"data_status":"READY","date":"2019-12-01","metrics":{"ENGAGEMENT":100,"CLICKTHROUGH_RATE":0.2,"CLICKTHROUGH":200,"CLOSEUP":37,"CLOSEUP_RATE":0.5,"ENGAGEMENT_RATE":0.2,"SAVE":20,"SAVE_RATE":0.18,"IMPRESSION":240}},{"data_status":"READY","date":"2019-12-01","metrics":{"ENGAGEMENT":100,"CLICKTHROUGH_RATE":0.2,"CLICKTHROUGH":200,"CLOSEUP":37,"CLOSEUP_RATE":0.5,"ENGAGEMENT_RATE":0.2,"SAVE":20,"SAVE_RATE":0.18,"IMPRESSION":240}}],"summary_metrics":{"ENGAGEMENT":100,"CLICKTHROUGH_RATE":0.2,"CLICKTHROUGH":200,"CLOSEUP":37,"CLOSEUP_RATE":0.5,"ENGAGEMENT_RATE":0.2,"SAVE":20,"SAVE_RATE":0.18,"IMPRESSION":240}}}