Skip to main content
GET
Weekday × hour engagement grid, read in the given timezone

Authorizations

Authorization
string
header
required

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

Query Parameters

profileId
string

Restrict to one profile.

accountId
string

Restrict to one connected account.

platform
enum<string>
Available options:
instagram,
whatsapp,
tiktok,
telegram,
youtube,
x,
facebook,
meta_ads,
linkedin
source
enum<string>

Where the post came from. plugkit = published through the API, external = published natively on the platform. Defaults to all.

Available options:
all,
plugkit,
external
from
string

Start of the window (ISO date). Defaults to 30 days ago.

to
string

End of the window (ISO date). Defaults to now.

timezone
string

IANA timezone the heatmap is read in (e.g. Europe/Paris). Defaults to UTC — an hour-of-day grid in the wrong timezone is worse than none.

Response

200 - undefined