Facebook Pages API Insights API

The Insights API from Facebook Pages API — 1 operation(s) for insights.

OpenAPI Specification

facebook-pages-insights-api-openapi.yml Raw ↑
openapi: 3.1.0
info:
  title: Meta Graph API - Pages Comments Insights API
  description: 'Graph API endpoints for reading and managing Facebook Pages -

    publishing posts and photos, retrieving Page insights, moderating

    comments, configuring Page metadata, and subscribing to webhook

    events. Authentication uses a Page access token obtained via OAuth

    2.0 with scopes such as pages_manage_posts, pages_read_engagement,

    pages_manage_metadata, pages_messaging, and pages_show_list.

    '
  version: v22.0
  contact:
    name: Meta for Developers
    url: https://developers.facebook.com/docs/pages-api
servers:
- url: https://graph.facebook.com/v22.0
  description: Meta Graph API
security:
- PageAccessToken:
  - pages_show_list
  - pages_manage_posts
  - pages_read_engagement
  - pages_manage_metadata
tags:
- name: Insights
paths:
  /{page-id}/insights:
    parameters:
    - $ref: '#/components/parameters/PageId'
    get:
      summary: Get Page insights metrics
      operationId: getPageInsights
      parameters:
      - name: metric
        in: query
        required: true
        schema:
          type: string
        description: Comma-separated metric names, e.g. page_impressions,page_fans
      - name: period
        in: query
        schema:
          type: string
          enum:
          - day
          - week
          - days_28
          - month
          - lifetime
      - name: since
        in: query
        schema:
          type: string
      - name: until
        in: query
        schema:
          type: string
      responses:
        '200':
          description: Insights values
      tags:
      - Insights
components:
  parameters:
    PageId:
      name: page-id
      in: path
      required: true
      schema:
        type: string
      description: Facebook Page ID
  securitySchemes:
    PageAccessToken:
      type: oauth2
      description: 'OAuth 2.0 Page access token. Granted scopes determine which

        endpoints can be called. Send as a Bearer token or as the

        access_token query parameter.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://www.facebook.com/v22.0/dialog/oauth
          tokenUrl: https://graph.facebook.com/v22.0/oauth/access_token
          scopes:
            pages_show_list: List Pages the user manages
            pages_manage_posts: Publish and edit posts
            pages_read_engagement: Read Page content and engagement
            pages_manage_metadata: Manage Page settings and subscribed apps
            pages_messaging: Send and receive Messenger messages
            pages_read_user_content: Read user-generated content on a Page
            pages_manage_engagement: Moderate comments and reactions