api.socialfetch.dev

{
  "description": "Standard success response envelope.",
  "properties": {
    "data": {
      "description": "Endpoint-specific response payload.",
      "properties": {
        "page": {
          "description": "Pagination state for the current response.",
          "properties": {
            "hasMore": {
              "description": "Whether another page of posts is available.",
              "type": "boolean"
            },
            "nextCursor": {
              "description": "Cursor to pass as `cursor` in the next request when more posts are available.",
              "nullable": true,
              "type": "string"
            }
          },
          "required": [
            "nextCursor",
            "hasMore"
          ],
          "type": "object"
        },
        "posts": {
          "description": "Facebook posts for the requested input. An empty array can mean no public posts were returned, the profile does not expose posts publicly, or the URL or id could not be resolved—there is no separate lookup status on this route.",
          "items": {
            "description": "A single Facebook post on a profile feed page.",
            "properties": {
              "authorDisplayName": {
                "description": "Display name for the post author when available.",
                "nullable": true,
                "type": "string"
              },
              "authorId": {
                "description": "Facebook id for the post author when available.",
                "type": "string"
              },
              "authorShortName": {
                "description": "Short display label for the author when Facebook provides one.",
                "nullable": true,
                "type": "string"
              },
              "commentCount": {
                "description": "Comment count when available.",
                "minimum": 0,
                "type": "integer"
              },
              "id": {
                "description": "Facebook post id.",
                "minLength": 1,
                "type": "string"
              },
              "imageUrl": {
                "description": "Primary image URL when the post includes a single primary image.",
                "type": "string"
              },
              "imageUrls": {
                "description": "Gallery image URLs when the post includes multiple images.",
                "items": {
                  "minLength": 1,
                  "type": "string"
                },
                "type": "array"
              },
              "publishTime": {
                "description": "When the post was published (Unix epoch seconds) when available.",
                "type": "integer"
              },
              "reactionCount": {
                "description": "Reaction count when available.",
                "minimum": 0,
                "type": "integer"
              },
              "text": {
                "description": "Post caption or text when present.",
                "nullable": true,
                "type": "string"
              },
              "topComments": {
                "description": "A small set of top comments when Facebook exposes them for the post.",
                "items": {
                  "description": "A top-level comment surfaced on a Facebook post.",
                  "properties": {
                    "authorDisplayName": {
                      "description": "Display name for the comment author when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "authorId": {
                      "description": "Facebook id for the comment author when available.",
                      "type": "string"
                    },
                    "authorUrl": {
                      "description": "Public Facebook URL for the comment author when available.",
                      "nullable": true,
                      "type": "string"
                    },
                    "id": {
                      "description": "Comment id.",
                      "minLength": 1,
                      "type": "string"
                    },
                    "publishTime": {
                      "description": "When the comment was published (Unix epoch seconds) when available.",
                      "type": "integer"
                    },
                    "text": {
                      "description": "Comment text when available.",
                      "nullable": true,
                      "type": "string"
                    }
                  },
                  "required": [
                    "id",
                    "text"
                  ],
                  "type": "object"
                },
                "type": "array"
              },
              "url": {
                "description": "Public Facebook URL for this post.",
                "minLength": 1,
                "type": "string"
              },
              "videoHdUrl": {
                "description": "High-definition video URL when this post includes playable video.",
                "type": "string"
              },
              "videoSdUrl": {
                "description": "Standard-definition video URL when this post includes playable video.",
                "type": "string"
              },
              "videoThumbnailUrl": {
                "description": "Video thumbnail image URL when available.",
                "type": "string"
              },
              "videoViewCount": {
                "description": "Video view count when available.",
                "minimum": 0,
                "nullable": true,
                "type": "integer"
              }
            },
            "required": [
              "id",
              "text",
              "url"
            ],
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "posts",
        "page"
      ],
      "type": "object"
    },
    "meta": {
      "description": "Metadata describing the request and billing outcome.",
      "properties": {
        "cached": {
          "description": "True when served from shared response cache. Credits still apply (full endpoint price); Age header may be present.",
          "type": "boolean"
        },
        "creditsCharged": {
          "description": "Credits charged for this request.",
          "minimum": 0,
          "type": "integer"
        },
        "requestId": {
          "description": "Unique request identifier for tracing this API call.",
          "minLength": 1,
          "type": "string"
        },
        "version": {
          "description": "Public API version that served the response.",
          "enum": [
            "v1"
          ],
          "type": "string"
        }
      },
      "required": [
        "requestId",
        "creditsCharged",
        "version"
      ],
      "type": "object"
    }
  },
  "required": [
    "data",
    "meta"
  ],
  "type": "object"
}