Skip to main content
GET
Get the analytics of an account

Authorizations

Authorization
string
header
required

A workspace API key: Authorization: Bearer osk_...

Path Parameters

workspace
string<uuid>
required

Your workspace UUID. Must match the API key's workspace.

account
string<uuid>
required

Account UUID.

Query Parameters

type
enum<string>
default:overview

One of the account's tabs.

Available options:
overview,
engagement,
content,
hashtags,
insights,
audience,
reach,
video,
competitors,
search_terms,
reviews
period
enum<string>
default:this_month

In UTC. Weeks start on Monday. this_week, this_month and this_year run up to today; last_3_months is the three whole months before this one. Ignored when date_from and date_to are both sent.

Available options:
this_week,
last_week,
this_month,
last_month,
last_3_months,
this_year
date_from
string<date>

Start of a custom range (UTC day). Send with date_to.

Example:

"2026-01-01"

date_to
string<date>

End of a custom range, on or after date_from. A range spans at most 366 days, both ends included.

Example:

"2026-01-31"

page
integer
default:1

content and reviews only.

Required range: x >= 1
per_page
integer

content and reviews only. Defaults to 25 posts or 10 reviews.

Required range: 1 <= x <= 50
sort_by
string

content only: a metric name, as the keys of a post's metrics (e.g. VIEW_COUNT, IMPRESSION_COUNT, LIKES). Newest first without it.

Maximum string length: 64
Example:

"VIEW_COUNT"

sort_dir
enum<string>
default:desc
Available options:
asc,
desc

Response

Success

account
object
type
string
Example:

"overview"

tabs
string[]
Example:
period
object

The range the figures cover, and the previous range of the same length every change is measured against.

initial_sync
object
data
object

Depends on the network and type. Compared figures are {value, change}, time series {date, value} lists, breakdowns {label, value} lists, and charts with several series an object of such lists.

Example: