Skip to main content
GET
Listar desempenho dos posts do canal

Authorizations

Authorization
string
header
required

Chave de API do workspace, criada em Configurações > Chaves de API.

Path Parameters

account
string<uuid>
required

Id da conta social (canal). Uma conta de outro workspace devolve 404.

Query Parameters

range
enum<string>
default:30d

7d (últimos 7 dias), 30d (últimos 30 dias, o padrão), mtd (mês até hoje) ou custom. Os dias são dias corridos no fuso horário do usuário dono da chave de API, incluindo hoje.

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

Primeiro dia, Y-m-d. Obrigatório com range=custom e ignorado nos outros períodos prontos. Enviar start e end sem range equivale a custom.

end
string<date>

Último dia, Y-m-d, igual ou depois de start. Obrigatório com range=custom.

labels[]
string<uuid>[]

Só posts com alguma destas etiquetas (etiquetas deste workspace). Etiquetas desconhecidas ou apagadas retornam 422.

untagged
enum<string>

Inclui (ou mostra só) posts sem etiqueta. Posts feitos fora do PostClean não têm etiquetas. Envie 1 ou 0; true e false são recusados com 422.

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

Só estes tipos de conteúdo. Eles precisam ser da rede do canal.

Formato do post numa rede. Precisa pertencer à rede do destino. GET /content-types lista os formatos de cada rede com as regras de mídia. Stories do Instagram e do Facebook não publicam texto.

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 classifica os posts do período anterior de mesmo tamanho.

Available options:
current,
previous
sort
enum<string>

Métrica usada na classificação. Quando o canal não informa essa métrica (ou ela não é enviada), vale a primeira desta lista que o canal informa; filters.sort mostra qual.

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

Response

Uma página de posts classificados.

data
object[]

Links para a primeira, a última, a anterior e a próxima página.

meta
object

Dados da página atual de uma lista paginada.

filters
object

Os filtros que o servidor aplicou, já com os valores padrão.