Synupv1
Criar chave
v1Recursos/Posts/getListar publicações

Listar publicações

Retorna as publicações de um local, as criadas mais recentemente primeiro, com o estado de envio por plataforma e estatísticas agregadas.

get/api/v1/posts
posts:read
Parâmetros de consulta
locationIdstringobrigatório
O local para o qual listar publicações. Obrigatório.
platformstringopcional
Restringe os resultados às publicações enviadas para esta plataforma.
typestring (announcement | event | offer)opcional
Restringe os resultados a um tipo de publicação.
statusstringopcional
Restringe os resultados a um status de publicação.
fromstringopcional
Inclui apenas publicações criadas nesta data ou depois.
tostringopcional
Inclui apenas publicações criadas nesta data ou antes.
searchstringopcional
Correspondência sem diferenciar maiúsculas/minúsculas com o nome da publicação.
pageintegeropcional
Número da página, começando em 1. O padrão é 1.
perPageintegeropcional
Resultados por página, até 50. O padrão é 20.
Resposta
dataobjectopcional
rowsarray of objectopcional
As publicações correspondentes.
idstringopcional
Identificador único da publicação.
namestringopcional
Nome/rótulo interno da publicação.
typestringopcional
Tipo de publicação: announcement, event ou offer.
statusstringopcional
Status do ciclo de vida da publicação: draft, scheduled, active ou error.
postDatestringopcional
A data agendada ou de criação da publicação, como timestamp ISO 8601.
platformsarray of stringopcional
As plataformas às quais esta publicação se destina.
firstMediaUrlstringopcional
URL do primeiro item de mídia da publicação, ou null.
firstMediaTypestringopcional
Tipo do primeiro item de mídia da publicação (image ou video), ou null.
submissionsarray of objectopcional
Estado de envio por plataforma para esta publicação.
platformstringopcional
A plataforma a que esta linha se refere.
statusstringopcional
Status deste envio de plataforma: pending, active, error ou deleted.
postLinkstringopcional
URL pública da publicação publicada nesta plataforma, ou null.
reviewStatestringopcional
Estado de moderação do Google (processing, live, rejected), ou null para outras plataformas.
errorMessagestringopcional
Mensagem de erro se este envio falhou, ou null.
messagePreviewstringopcional
Os primeiros 140 caracteres da legenda da publicação, ou null.
viewsnumberopcional
Número total de visualizações, ou null se ainda não disponível.
clicksnumberopcional
Número total de cliques, ou null se ainda não disponível.
errorMsgstringopcional
Mensagem de erro do primeiro envio com falha, ou null.
deletedOnstringopcional
Quando esta publicação foi removida, como timestamp ISO 8601, ou null.
totalnumberopcional
Número total de publicações correspondentes.
statsobjectopcional
Estatísticas agregadas das publicações correspondentes.
totalPostsnumberopcional
Número de publicações correspondentes.
totalViewsnumberopcional
Total de visualizações nas publicações correspondentes, ou null.
totalClicksnumberopcional
Total de cliques nas publicações correspondentes, ou null.
totalEngagementnumberopcional
Total de reações, compartilhamentos e comentários combinados nas publicações correspondentes.
Erros
400Falta um parâmetro obrigatório na solicitação, ou ela é inválida de outra forma.
401Chave de API ausente, inválida, expirada ou revogada.
403A chave não tem a permissão exigida, ou não está autorizada para este cliente/local.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/posts
Sua chave de API
locationId *
platform
type
status
from
to
search
page
perPage
{
  "data": {
    "rows": [
      {
        "id": "cm_post_abc123",
        "name": "Fall Special Announcement",
        "type": "announcement",
        "status": "scheduled",
        "postDate": "2026-02-10T15:00:00.000Z",
        "platforms": [
          "google",
          "facebook"
        ],
        "firstMediaUrl": "https://cdn.synup.com/uploads/a1/promo.jpg",
        "firstMediaType": "image",
        "submissions": [
          {
            "platform": "google",
            "status": "pending",
            "postLink": null,
            "reviewState": null,
            "errorMessage": null
          },
          {
            "platform": "facebook",
            "status": "pending",
            "postLink": null,
            "reviewState": null,
            "errorMessage": null
          }
        ],
        "messagePreview": "Join us this weekend for our fall special — 20% off all services!",
        "views": null,
        "clicks": null,
        "errorMsg": null,
        "deletedOn": null
      }
    ],
    "total": 1,
    "stats": {
      "totalPosts": 12,
      "totalViews": 4300,
      "totalClicks": 210,
      "totalEngagement": 96
    }
  }
}