api.socialfetch.dev

{
  "description": "Standard success response envelope.",
  "properties": {
    "data": {
      "description": "Endpoint-specific response payload.",
      "properties": {
        "lookupStatus": {
          "description": "Whether the group resolved for this request.",
          "enum": [
            "found",
            "not_found"
          ],
          "type": "string"
        },
        "page": {
          "description": "Pagination information for the current response.",
          "properties": {
            "hasMore": {
              "description": "Whether another page of posts can be requested.",
              "type": "boolean"
            },
            "nextCursor": {
              "description": "Cursor to pass as `cursor` in the next request when `hasMore` is true; otherwise null.",
              "nullable": true,
              "type": "string"
            }
          },
          "required": [
            "nextCursor",
            "hasMore"
          ],
          "type": "object"
        },
        "posts": {
          "description": "Posts returned for the requested group. This array may be empty when the group resolves but no posts are returned.",
          "items": {
            "description": "A single post from a Facebook group feed.",
            "properties": {
              "author": {
                "description": "Author summary for this post.",
                "properties": {
                  "id": {
                    "description": "Platform identifier for the post author when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "name": {
                    "description": "Display name for the post author when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "url": {
                    "description": "Public profile URL for the post author when available.",
                    "nullable": true,
                    "type": "string"
                  }
                },
                "required": [
                  "id",
                  "name",
                  "url"
                ],
                "type": "object"
              },
              "commentCount": {
                "description": "Comment count for the post when available.",
                "minimum": 0,
                "nullable": true,
                "type": "integer"
              },
              "id": {
                "description": "Stable identifier for the post.",
                "minLength": 1,
                "type": "string"
              },
              "publishedAt": {
                "description": "ISO-8601 timestamp for when the post was published, when available.",
                "nullable": true,
                "type": "string"
              },
              "reactionCount": {
                "description": "Reaction count for the post when available.",
                "minimum": 0,
                "nullable": true,
                "type": "integer"
              },
              "text": {
                "description": "Text body of the post when available.",
                "nullable": true,
                "type": "string"
              },
              "url": {
                "description": "Canonical public URL for this Facebook group post.",
                "minLength": 1,
                "type": "string"
              },
              "video": {
                "description": "Embedded video metadata when this post includes video.",
                "properties": {
                  "durationMs": {
                    "description": "Video duration in milliseconds when available.",
                    "minimum": 0,
                    "nullable": true,
                    "type": "integer"
                  },
                  "hdUrl": {
                    "description": "High-definition video URL when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "sdUrl": {
                    "description": "Standard-definition video URL when available.",
                    "nullable": true,
                    "type": "string"
                  },
                  "thumbnailUrl": {
                    "description": "Thumbnail image URL for embedded video when available.",
                    "nullable": true,
                    "type": "string"
                  }
                },
                "required": [
                  "thumbnailUrl",
                  "durationMs",
                  "sdUrl",
                  "hdUrl"
                ],
                "type": "object"
              }
            },
            "required": [
              "id",
              "url",
              "text",
              "publishedAt",
              "reactionCount",
              "commentCount",
              "author",
              "video"
            ],
            "type": "object"
          },
          "type": "array"
        }
      },
      "required": [
        "lookupStatus",
        "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"
}