Flows
Get Endpoint Metrics

Get Flow

Can request specific fields by enabling the `fields` query param

get/{Version}/{Flow-ID}

Request

  • Base URL
    https://graph.facebook.com
  • URL
    https://graph.facebook.com/{Version}/{Flow-ID}
  • Auth
    HTTP bearer

Query parameters

fieldsstring
Example:id,name,categories,preview,status,validation_errors,json_version,data_api_version,data_channel_uri,health_status,whatsapp_business_account,application

Return specific fields in the response

date_formatstring
Example:U

Returns date as unix timestamp in seconds

Headers

User-Agentstring
Example:Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21

The user agent string identifying the client software making the request.

Authorizationstring required
Example:Bearer EAABwzLixnjYBOzYmNMJJGfHq9DgNh...

Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.

Response

Get Flow / Get Preview URL / Get Endpoint Request Count Metric / Get Endpoint Request Error Metric / Get Endpoint Request Error Rate Metric / Get Endpoint Request Latencies Metric / Get Endpoint Availability Metric

categoriesstring[]
data_api_versionstring
data_channel_uristring
idstring
json_versionstring
namestring
statusstring

Example response

{
  "application": {
    "id": "app-1",
    "link": "https://www.facebook.com/games/?app_id=app-1",
    "name": "My Awesome App"
  },
  "categories": [
    "OTHER"
  ],
  "data_api_version": "3.0",
  "data_channel_uri": "https://example.com",
  "health_status": {
    "can_send_message": "BLOCKED",
    "entities": [
      {
        "can_send_message": "AVAILABLE",
        "entity_type": "FLOW",
        "id": "flow-1"
      },
      {
        "can_send_message": "BLOCKED",
        "entity_type": "WABA",
        "errors": [
          {
            "error_code": 141006,
            "error_description": "There is an error with the payment method. This will block business initiated conversations.",
            "possible_solution": "There was an error with your payment method. Please add a new payment method to the account."
          },
          {
            "error_code": 141014,
            "error_description": "The WABA is banned.",
            "possible_solution": "Please visit Business Support Home for more details (https://business.facebook.com/accountquality) on how to appeal the ban."
          }
        ],
        "id": "waba-1"
      },
      {
        "can_send_message": "LIMITED",
        "entity_type": "BUSINESS",
        "errors": [
          {
            "error_code": 141010,
            "error_description": "The Business has not passed business verification.",
            "possible_solution": "Visit business settings and start or resolve the business verification request."
          }
        ],
        "id": "business-1"
      },
      {
        "can_send_message": "AVAILABLE",
        "entity_type": "APP",
        "id": "app-1"
      }
    ]
  },
  "id": "flow-1",
  "json_version": "2.1",
  "metric": {
    "data_points": [
      {
        "data": [
          {
            "key": "value",
            "value": 138
          }
        ],
        "timestamp": "2024-01-28T08:00:00+0000"
      },
      {
        "data": [
          {
            "key": "value",
            "value": 361
          }
        ],
        "timestamp": "2024-01-29T08:00:00+0000"
      }
    ],
    "granularity": "DAY",
    "name": "ENDPOINT_REQUEST_COUNT"
  },
  "name": "my first flow",
  "preview": {
    "expires_at": "2023-05-21T11:18:09+0000",
    "preview_url": "https://business.facebook.com/wa/manage/flows/55000..../preview/?token=b9d6....."
  },
  "status": "DRAFT",
  "validation_errors": [],
  "whatsapp_business_account": {
    "business_type": "ent",
    "id": "waba-1",
    "message_template_namespace": "namespace-1",
    "name": "My Awesome WABA",
    "timezone_id": "54"
  }
}

Changes

No recorded changes to this operation across all 5 revisions of this API.