v1Resources/Posts/getRead publishing series analytics

Read publishing series analytics

Requires an active agency user with Social access and access to the client. Returns how a client's posts performed, grouped by publishing series. Pass seriesId for one series, and compareId to compare it with a second one; leave seriesId out or send all to get every series. from and to default to the last 30 days and can cover up to one year. channel is brand (the default) or local, and tag filters local posts, so it requires channel=local. locationId must belong to the client. Interactions are reactions plus comments plus shares. Follower counts aren't attributed to a series, and reach can't be added up into a unique audience.

get/api/v1/posts/analytics/series
posts:read
Query parameters
clientIdstringrequired
locationIdstringoptional
channelstring (brand | local)optional
tagstringoptional
seriesIdstringoptional
compareIdstringoptional
platformstringoptional
fromstringoptional
tostringoptional
Response
dataobjectoptional
Errors
400The request is missing a required parameter or is otherwise malformed.
401Missing, invalid, expired, or revoked API key.
403The key lacks the required scope, or isn't authorized for this client/location.
404The resource wasn't found, or doesn't belong to your agency.
429Too many requests. Retry after the number of seconds in the Retry-After header.
503The post analytics could not be read.
get/api/v1/posts/analytics/series
Your API key
clientId *
locationId
channel
tag
seriesId
compareId
platform
from
to
{}

Guides that use this resource