Skip to main content
GET
Get Analytics Report

Authorizations

Authorization
string
header
required

Send an account API key in the Authorization: Bearer <key> header.

Headers

OpenPMM-Request-Id
string

Optional request ID. OpenPMM returns this value when it is valid. Otherwise, OpenPMM creates a request ID.

Maximum string length: 128

Path Parameters

workspace_id
string
required

Unique workspace ID.

Example:

"ws_01JABCDEF"

Query Parameters

from
string<date>
required

First local publication date to include.

until
string<date>
required

Exclusive local publication date limit.

bucket
enum<string>
default:day

Publication cohort size.

Available options:
day,
week
channel
enum<string>

Return only entries for this publishing channel.

Available options:
bluesky,
facebook,
instagram,
threads,
mastodon,
x,
linkedin,
tiktok,
youtube
limit
integer
default:25

Maximum number of items to return.

Required range: 1 <= x <= 100
after
string

The next_cursor value from the previous page. Send this value without changes.

Response

The analytics report.

object
string
required
Allowed value: "analytics_report"
from
string<date>
required
until
string<date>
required
bucket
enum<string>
required
Available options:
day,
week
time_zone
string
required
Example:

"Europe/Berlin"

buckets
object[]
required
entries
object[]
required
has_more
boolean
required
next_cursor
string | null
required