Skip to main content
GET
List channel post performance

Authorizations

Authorization
string
header
required

Workspace API key from Settings → API Keys.

Path Parameters

account
string<uuid>
required

Social account (channel) id. An account of another workspace returns 404.

Query Parameters

range
enum<string>
default:30d

7d (last 7 days), 30d (last 30 days, the default), mtd (month to date) or custom. Days are calendar days in the API key user's time zone, today included.

Available options:
7d,
30d,
mtd,
custom
start
string<date>

First day, Y-m-d. Required with range=custom and ignored for the other presets. Sending start and end without range means custom.

end
string<date>

Last day, Y-m-d, on or after start. Required with range=custom.

labels[]
string<uuid>[]

Only posts with any of these labels (labels of this workspace). Unknown or deleted labels return 422.

untagged
enum<string>

Also (or only) posts without labels. Posts made outside TryPost have no labels. Send 1 or 0; true and false are rejected with 422.

Available options:
1,
0
types[]
enum<string>[]

Only these content types. They must belong to the channel's network.

Post format on one network. It must belong to the destination's network. GET /content-types lists the formats of each network with their media rules. Instagram and Facebook stories publish no text.

Available options:
instagram_feed,
instagram_reel,
instagram_story,
linkedin_post,
linkedin_page_post,
facebook_post,
facebook_reel,
facebook_story,
tiktok_video,
tiktok_photo,
youtube_short,
x_post,
threads_post,
threads_ghost_post,
pinterest_pin,
pinterest_video_pin,
pinterest_carousel,
bluesky_post,
mastodon_post,
telegram_post,
discord_message,
google_business_post
period
enum<string>
default:current

previous ranks the posts of the previous range of the same length.

Available options:
current,
previous
sort
enum<string>

Metric to rank by. When the channel does not report it (or it is omitted), the first of these the channel reports is used; filters.sort says which.

Available options:
reactions,
comments,
engagement_rate,
views,
impressions,
shares,
saves,
reach
page
integer
default:1
Required range: x >= 1

Response

A page of ranked posts.

data
object[]
meta
object
filters
object

The filters the server applied, after defaults.