Raw schema
{
"type": "object",
"properties": {
"post_id": {
"description": "One post by id. The other filters are ignored.",
"type": "string"
},
"from": {
"description": "ISO date or date-time. Only posts that went out, or are due to, at or after this.",
"type": "string"
},
"to": {
"description": "ISO date or date-time. Only posts before this.",
"type": "string"
},
"status": {
"description": "published, scheduled, draft, failed or cancelled. A post matches when any of its destinations is in one of these states.",
"type": "array",
"items": {
"type": "string",
"enum": [
"published",
"scheduled",
"draft",
"failed",
"cancelled"
]
}
},
"platform": {
"type": "array",
"items": {
"type": "string",
"enum": [
"tiktok",
"instagram",
"facebook",
"x",
"youtube",
"linkedin"
]
}
},
"account_id": {
"description": "Accounts by id, from accounts_list.",
"type": "array",
"items": {
"type": "string"
}
},
"group": {
"description": "Groups by name, from groups_list: posts to any of their accounts.",
"type": "array",
"items": {
"type": "string"
}
},
"product": {
"description": "Products by name or id: posts to accounts linked to them.",
"type": "array",
"items": {
"type": "string"
}
},
"source": {
"description": "Where a post came from. external is one made on the platform itself and found afterwards.",
"type": "array",
"items": {
"type": "string",
"enum": [
"web",
"mcp",
"api",
"campaign",
"external"
]
}
},
"search": {
"description": "Text the caption contains, ignoring case.",
"type": "string",
"minLength": 1,
"maxLength": 200
},
"sort_by": {
"description": "A counter or insight (views, likes, β¦), \"when\", \"updated\" or \"account\". Defaults to newest first.",
"type": "string",
"enum": [
"views",
"likes",
"comments",
"shares",
"saves",
"reach",
"totalWatchMs",
"replays",
"follows",
"when",
"updated",
"account"
]
},
"order": {
"description": "Defaults to desc.",
"type": "string",
"enum": [
"asc",
"desc"
]
},
"period": {
"description": "The window each figure's change is measured over. Defaults to 24h.",
"type": "string",
"enum": [
"24h",
"7d"
]
},
"limit": {
"description": "Posts per page. Defaults to 25.",
"type": "integer",
"minimum": 1,
"maximum": 100
},
"cursor": {
"description": "nextCursor from the previous page.",
"type": "string"
},
"rank_by": {
"description": "Rank the matching posts by one figure of their best destination instead: any counter (views, likes, β¦) or insight (reach, avgWatchMs, completionRate, retentionAt3s, retentionAtHalf, β¦). Answers \"which hooks held viewers\" or \"what is moving now\". Ranks up to 500 matching posts; no cursor.",
"type": "string",
"enum": [
"views",
"likes",
"comments",
"shares",
"saves",
"reach",
"totalWatchMs",
"avgWatchMs",
"replays",
"follows",
"completionRate",
"retentionAt3s",
"retentionAtHalf"
]
},
"by": {
"description": "With rank_by: the running total, or how much it moved over the period. Defaults to the total. Insights rank by value only.",
"type": "string",
"enum": [
"value",
"change"
]
}
},
"$schema": "https://json-schema.org/draft/2020-12/schema"
}