Get user account analytics
GET {{baseUrl}}/user_account/analytics?start_date=<date>&end_date=<date>&from_claimed_content=BOTH&pin_format=ALL&app_types=ALL&source=ALL&metric_types=ENGAGEMENT_RATE,OUTBOUND_CLICK_RATE&split_field=NO_SPLIT&ad_account_id=47
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
| Key | Datatype | Required | Description |
|---|---|---|---|
start_date | string | (Required) Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today. | |
end_date | string | (Required) Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date. | |
from_claimed_content | string | Filter on Pins that match your claimed domain. | |
pin_format | string | Pin formats to get data for, default is all. | |
app_types | string | Apps or devices to get data for, default is all. | |
source | string | Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts | |
metric_types | string | Metric types to get data for, default is all. | |
split_field | string | How to split the data into groups. Not including this param means data won't be split. | |
ad_account_id | number | Unique identifier of an ad account. |
HEADERS
| Key | Datatype | Required | Description |
|---|---|---|---|
Accept | string |
RESPONSES
status: OK
{"velitb30":{"daily_metrics":[{"data_status":"AUDIENCE_TOTAL_SMALLER_THAN_THRESHOLD","date":"\u003cstring\u003e","metrics":{"dolor_f":"\u003cnumber\u003e"}},{"data_status":"ESTIMATE","date":"\u003cstring\u003e","metrics":{"amet0":"\u003cnumber\u003e"}}],"summary_metrics":{"non7":"\u003cnumber\u003e","nulla_78":"\u003cnumber\u003e"}},"inbc5":{"daily_metrics":[{"data_status":"PURCHASERS_METRIC_SMALLER_THAN_THRESHOLD","date":"\u003cstring\u003e","metrics":{"culpaedf":"\u003cnumber\u003e"}},{"data_status":"BEFORE_AUDIENCE_MONTHLY_METRIC_START_DATE","date":"\u003cstring\u003e","metrics":{"elitbd3":"\u003cnumber\u003e","dolore3":"\u003cnumber\u003e","dolore_e0":"\u003cnumber\u003e"}}],"summary_metrics":{"anim_5_e":"\u003cnumber\u003e","aliquabb_":"\u003cnumber\u003e"}},"consectetur___e":{"daily_metrics":[{"data_status":"BEFORE_AUDIENCE_METRIC_START_DATE","date":"\u003cstring\u003e","metrics":{"enim_85c":"\u003cnumber\u003e","laborum_765":"\u003cnumber\u003e","dolorec9":"\u003cnumber\u003e"}},{"data_status":"BEFORE_CONVERSION_METRIC_START_DATE","date":"\u003cstring\u003e","metrics":{"quibe":"\u003cnumber\u003e"}}],"summary_metrics":{"aute7d":"\u003cnumber\u003e"}},"ea_1":{"daily_metrics":[{"data_status":"BEFORE_VIDEO_METRIC_START_DATE","date":"\u003cstring\u003e","metrics":{"laboris0":"\u003cnumber\u003e","ex_73":"\u003cnumber\u003e","irure_1":"\u003cnumber\u003e"}},{"data_status":"BEFORE_AUDIENCE_MONTHLY_METRIC_START_DATE","date":"\u003cstring\u003e","metrics":{"cupidatat_4":"\u003cnumber\u003e","nullad":"\u003cnumber\u003e","consectetur_e1":"\u003cnumber\u003e"}}],"summary_metrics":{"qui4":"\u003cnumber\u003e","ad2dd":"\u003cnumber\u003e"}}}