Post data model
View field support, webhooks, and list parameters for each integration on the Supported Integrations page.
| Field | Type | Required | Description |
|---|---|---|---|
id | string | No | Unique identifier for the post |
created_at | string (date-time) | No | When the post was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
updated_at | string (date-time) | No | When the post was last updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
profile_id | string | No | The social profile (page/handle/listing) that owns this post |
parent_post_id | string | No | The post this one replies to or references |
title | string | No | Optional post title/headline |
body | string | No | The main text content of the post |
status | enum | No | Publication status of the post Values: DRAFT, SCHEDULED, PUBLISHED, REJECTED, PROCESSING, DELETED, OTHER |
type | enum | No | The kind of post Values: POST, REPLY, REPOST, QUOTE, EVENT, OFFER, ALERT, STORY, OTHER |
media | SocialMedia[] | No | Media assets attached to the post |
media[].id | string | No | Provider media id, when the media is individually addressable |
media[].url | string | Yes | URL of the media asset |
media[].alt | string | No | Accessibility caption / alt text |
media[].type | enum | No | Type of media Values: PHOTO, VIDEO, GIF, OTHER |
media[].height | number | No | Media height in pixels |
media[].width | number | No | Media width in pixels |
media[].position | number | No | Ordering of the media within the post; 1 is the first |
url | string | No | Public permalink to the post |
language | string | No | Language code of the post content |
scheduled_at | string (date-time) | No | When the post is scheduled to publish (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format) |
call_to_action | object | No | Call-to-action button on the post |
call_to_action.type | enum | No | The call-to-action button type Values: BOOK, ORDER, SHOP, LEARN_MORE, SIGN_UP, CALL, OTHER |
call_to_action.url | string | No | The URL the call-to-action points to |
metrics | object | No | Engagement metrics for the post |
metrics.like_count | number | No | Number of likes/reactions |
metrics.comment_count | number | No | Number of comments/replies |
metrics.share_count | number | No | Number of shares/reposts |
metrics.quote_count | number | No | Number of quotes |
metrics.view_count | number | No | Number of views/impressions |
metrics.bookmark_count | number | No | Number of bookmarks/saves |
Are we missing anything? Let us know