Synupv1
Criar chave
v1Recursos/Posts/getObter uma publicação

Obter uma publicação

Retorna uma única publicação, incluindo o desempenho de seus envios por plataforma.

get/api/v1/posts/{id}
posts:read
Parâmetros de consulta
idstringobrigatório
A publicação a ser consultada.
Resposta
dataobjectopcional
Podem existir campos internos adicionais que não fazem parte do contrato estável — baseie-se apenas nos campos documentados aqui.
idstringopcional
Identificador único da publicação.
namestringopcional
Nome/rótulo interno da publicação.
typestringopcional
Tipo de publicação (duplicado de postType, mantido para compatibilidade retroativa).
statusstring (draft | scheduled | active | error)opcional
Status do ciclo de vida da publicação: draft, scheduled, active ou error.
postTypestring (announcement | event | offer)opcional
Tipo de publicação: announcement, event ou offer.
clientIdstringopcional
ID do cliente ao qual esta publicação pertence.
locationIdstringopcional
ID do local ao qual esta publicação pertence, ou null para uma publicação em nível de marca.
locationNamestringopcional
Nome de exibição do local da publicação, ou null.
clientNamestringopcional
Nome de exibição do cliente da publicação, ou null.
platformsarray of stringopcional
As plataformas às quais esta publicação se destina.
messageGooglestringopcional
Legenda usada para o Google, ou null.
messageFacebookstringopcional
Legenda social compartilhada usada por toda plataforma que não seja Google, ou null.
ctaTypestringopcional
Tipo de chamada para ação, ou null.
ctaUrlstringopcional
URL da chamada para ação, ou null.
ctaUrlFacebookstringopcional
URL da chamada para ação específica do Facebook, ou null.
xThreadbooleanopcional
Se o modo de thread do X está ativado (ignora o limite de 280 caracteres).
ctaJsonobjectopcional
Configurações brutas de chamada para ação e segmentação por plataforma.
mediaUrlsarray of objectopcional
Mídia anexada à publicação, uma entrada por anexo de plataforma.
urlstringopcional
platformstringopcional
typestring (image | video)opcional
eventTitlestringopcional
Título do evento ou oferta, ou null.
eventStartAtstringopcional
Horário de início do evento ou oferta, como timestamp ISO 8601, ou null.
eventEndAtstringopcional
Horário de término do evento ou oferta, como timestamp ISO 8601, ou null.
offerTermsstringopcional
Termos da oferta, ou null.
offerCouponCodestringopcional
Código do cupom da oferta, ou null.
offerRedeemUrlstringopcional
URL de resgate da oferta, ou null.
scheduledForstringopcional
Quando a publicação está agendada para ser publicada, como timestamp ISO 8601, ou null para publicar imediatamente.
createdAtstringopcional
Data de criação da publicação, como timestamp ISO 8601.
performancearray of objectopcional
Desempenho de envio por plataforma para esta publicação.
submissionIdstringopcional
Identificador único do envio à plataforma.
connectionIdstringopcional
ID da conexão pela qual este envio foi feito.
sitestringopcional
A plataforma à qual este envio se destina.
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.
reactionsnumberopcional
Número total de reações.
sharesnumberopcional
Número total de compartilhamentos.
commentsnumberopcional
Número total de comentários.
statusstringopcional
Status deste envio de plataforma: pending, active, error ou deleted.
platformPostIdstringopcional
O id próprio da plataforma para a publicação publicada, ou null.
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.
Erros
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.
404O recurso não foi encontrado, ou não pertence à sua agência.
429Muitas solicitações. Tente novamente após o número de segundos indicado no cabeçalho Retry-After.
get/api/v1/posts/{id}
Sua chave de API
id *
{
  "data": {
    "id": "cm_post_abc123",
    "name": "Fall Special Announcement",
    "type": "announcement",
    "status": "scheduled",
    "postType": "announcement",
    "clientId": "cm_client_1",
    "locationId": "cm_loc_1",
    "locationName": "Acme Dental — Downtown",
    "clientName": "Acme Dental",
    "platforms": [
      "google",
      "facebook"
    ],
    "messageGoogle": "Join us this weekend for our fall special — 20% off all services!",
    "messageFacebook": "Join us this weekend for our fall special — 20% off all services!",
    "ctaType": "learn_more",
    "ctaUrl": "https://acmedental.example.com/fall-special",
    "ctaUrlFacebook": null,
    "xThread": false,
    "ctaJson": {
      "ctaType": "learn_more",
      "ctaUrl": "https://acmedental.example.com/fall-special",
      "ctaUrlFacebook": null,
      "xThread": false
    },
    "mediaUrls": [
      {
        "url": "https://cdn.synup.com/uploads/a1/promo.jpg",
        "platform": "facebook",
        "type": "image"
      }
    ],
    "eventTitle": null,
    "eventStartAt": null,
    "eventEndAt": null,
    "offerTerms": null,
    "offerCouponCode": null,
    "offerRedeemUrl": null,
    "scheduledFor": "2026-02-10T15:00:00.000Z",
    "createdAt": "2026-01-20T09:12:00.000Z",
    "performance": [
      {
        "submissionId": "cm_sub_xyz789",
        "connectionId": "cm_conn_1",
        "site": "facebook",
        "views": 890,
        "clicks": null,
        "reactions": 42,
        "shares": 6,
        "comments": 9,
        "status": "active",
        "platformPostId": "1234567890",
        "postLink": "https://www.facebook.com/1234567890",
        "reviewState": null,
        "errorMessage": null
      }
    ]
  }
}