Skip to navigation

Break a selection down by account, platform, tag, type, collection, or period

Requires posts:read (by: collection also needs collections:read). Rolls a selection (up to 1,000 posts) up by account, platform, tag, contentType, collection, week (Monday, UTC, by post date), or month. Each group is the comment-weighted rollup of its posts’ stored scores — the dashboard’s combined-by-account math — with its share of the selection’s posts and comments and its difference from the whole selection (meta.overall).

A post with several tags or collections counts once in each, so tag and collection groups can add up to more than the selection (meta.multiMembership: true). Posts with no date group as undated.

Default sort: postCount descending, or key ascending for week / month. JSON returns up to limit groups (default 50, max 200); format=csv returns every group.

Rate class breakdowns (20 / minute, 500 / day per key).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

OR
X-Api-Keystring
API Key authentication via header

Request

This endpoint expects an object.
selectionobjectRequired

Which content the analysis covers. Provide exactly one of postIds or posts; collectionId may stand alone or be combined with posts filters to narrow within the collection. Resolves to at most 1,000 posts (newest first).

byenumRequired
sortstring or objectOptional
limitintegerOptional1-200Defaults to 50
formatenumOptionalDefaults to json
Allowed values:

Response

Breakdown groups (JSON) or every group as CSV

datalist of objectsOptional
metaobjectOptional

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
429
Too Many Requests Error