WhatsApp

WhatsApp Get Endpoint Metrics API

The Get Endpoint Metrics API from WhatsApp — 1 operation(s) for get endpoint metrics.

GitHub OpenAPI

Operations 1

GET /{Version}/{Flow-ID} Get Flow #

Documentation

📖
Documentation
https://developers.facebook.com/documentation/business-messaging/whatsapp/overview

Specifications

⚙
OpenAPI
https://artifacts.apis.io/whatsapp/openapi/whatsapp-get-endpoint-metrics-api-openapi.yml

SDKs

📦
GitHubRepository
https://github.com/meta/openapi

Schemas & Data

📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-call-request-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-business-account-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-business-profile-node-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-phone-number-info-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-call-permission-check-response-payload-schema.json
📊
JSONSchema
https://artifacts.apis.io/whatsapp/json-schema/whatsapp-whats-app-account-number-schema.json

Other Resources

🔗
PostmanCollection
https://raw.githubusercontent.com/WhatsApp/WhatsApp-Flows-Tools/main/postman/v1/whatsapp-cloud-api.postman_collection.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/whatsapp:whatsapp-get-endpoint-metrics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

whatsapp-get-endpoint-metrics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Meta Graph API - Application Connected Client Businesses…
  version: v23.0
  description: 'API for retrieving connected client businesses associated with a Meta application.


    This endpoint allows applications to retrieve information about businesses that have

    established client connections through the application. This is essential for managing

    business relationships and understanding client business configurations.'
  contact:
    name: Meta Business Platform Team
    url: https://developers.facebook.com/support
  license:
    name: Meta Platform Terms
    url: https://developers.facebook.com/terms
  termsOfService: https://developers.facebook.com/terms
servers:
- url: https://graph.facebook.com
  description: Production Graph API server
- url: https://graph.facebook.com
- url: https://graph.facebook.com
  description: WhatsApp Business Cloud API
- url: https://graph.facebook.com
  description: Meta Graph API production server
tags:
- name: Get Endpoint Metrics
paths:
  /{Version}/{Flow-ID}:
    parameters:
    - $ref: '#/components/parameters/UserAgent'
    - $ref: '#/components/parameters/Authorization'
    - name: Version
      in: path
      required: true
      schema:
        type: string
    - name: Flow-ID
      in: path
      required: true
      schema:
        type: string
    get:
      tags:
      - Get Endpoint Metrics
      summary: Get Flow
      description: Can request specific fields by enabling the \`fields\` query param
      operationId: getFlow
      parameters:
      - $ref: '#/components/parameters/UserAgent'
      - $ref: '#/components/parameters/Authorization'
      - name: fields
        in: query
        schema:
          type: string
          example: id,name,categories,preview,status,validation_errors,json_version,data_api_version,data_channel_uri,health_status,whatsapp_business_account,application
        description: Return specific fields in the response
      - name: date_format
        in: query
        schema:
          type: string
          example: U
        description: Returns date as unix timestamp in seconds
      responses:
        '200':
          description: 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
          content:
            application/json:
              schema:
                type: object
                properties:
                  application:
                    type: object
                    properties:
                      id:
                        type: string
                        example: app-1
                      link:
                        type: string
                        example: https://www.facebook.com/games/?app_id=app-1
                      name:
                        type: string
                        example: My Awesome App
                  categories:
                    type: array
                    items:
                      type: string
                      example: OTHER
                    example:
                    - OTHER
                  data_api_version:
                    type: string
                    example: '3.0'
                  data_channel_uri:
                    type: string
                    example: https://example.com
                  health_status:
                    type: object
                    properties:
                      can_send_message:
                        type: string
                        example: BLOCKED
                      entities:
                        type: array
                        items:
                          type: object
                          properties:
                            can_send_message:
                              type: string
                              example: AVAILABLE
                            entity_type:
                              type: string
                              example: FLOW
                            errors:
                              type: array
                              items:
                                type: object
                                properties:
                                  error_code:
                                    type: number
                                    example: 141006
                                  error_description:
                                    type: string
                                    example: There is an error with the payment method. This will block business initiated conversations.
                                  possible_solution:
                                    type: string
                                    example: There was an error with your payment method. Please add a new payment method to the account.
                              example:
                              - 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:
                              type: string
                              example: flow-1
                        example:
                        - 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:
                    type: string
                    example: flow-1
                  json_version:
                    type: string
                    example: '2.1'
                  metric:
                    type: object
                    properties:
                      data_points:
                        type: array
                        items:
                          type: object
                          properties:
                            data:
                              type: array
                              items:
                                type: object
                                properties:
                                  key:
                                    type: string
                                    example: value
                                  value:
                                    type: number
                                    example: 138
                              example:
                              - key: value
                                value: 138
                            timestamp:
                              type: string
                              example: 2024-01-28T08:00:00+0000
                        example:
                        - 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:
                        type: string
                        example: DAY
                      name:
                        type: string
                        example: ENDPOINT_REQUEST_COUNT
                  name:
                    type: string
                    example: my first flow
                  preview:
                    type: object
                    properties:
                      expires_at:
                        type: string
                        example: 2023-05-21T11:18:09+0000
                      preview_url:
                        type: string
                        example: https://business.facebook.com/wa/manage/flows/55000..../preview/?token=b9d6.....
                  status:
                    type: string
                    example: DRAFT
                  validation_errors:
                    type: array
                    items: {}
                    example: []
                  whatsapp_business_account:
                    type: object
                    properties:
                      business_type:
                        type: string
                        example: ent
                      id:
                        type: string
                        example: waba-1
                      message_template_namespace:
                        type: string
                        example: namespace-1
                      name:
                        type: string
                        example: My Awesome WABA
                      timezone_id:
                        type: string
                        example: '54'
              examples:
                Get Endpoint Availability Metric:
                  value:
                    id: flow-1
                    metric:
                      data_points:
                      - data:
                        - key: succeeded
                          value: 713
                        - key: failed
                          value: 335
                        timestamp: 2024-01-28T08:00:00+0000
                      - data:
                        - key: succeeded
                          value: 623
                        - key: failed
                          value: 2
                        timestamp: 2024-01-29T08:00:00+0000
                      granularity: DAY
                      name: ENDPOINT_AVAILABILITY
                Get Endpoint Request Count Metric:
                  value:
                    id: flow-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
                Get Endpoint Request Error Metric:
                  value:
                    id: flow-1
                    metric:
                      data_points:
                      - data:
                        - key: timeout_error
                          value: 25
                        timestamp: 2024-01-28T08:00:00+0000
                      - data:
                        - key: timeout_error
                          value: 64
                        timestamp: 2024-01-29T08:00:00+0000
                      granularity: DAY
                      name: ENDPOINT_REQUEST_ERROR
                Get Endpoint Request Error Rate Metric:
                  value:
                    id: flow-1
                    metric:
                      data_points:
                      - data:
                        - key: value
                          value: 0.12625250501002
                        timestamp: 2024-01-28T08:00:00+0000
                      granularity: LIFETIME
                      name: ENDPOINT_REQUEST_ERROR_RATE
                Get Endpoint Request Latencies Metric:
                  value:
                    id: flow-1
                    metric:
                      data_points:
                      - data:
                        - key: '1'
                          value: 106
                        timestamp: 2024-01-28T08:00:00+0000
                      - data:
                        - key: '1'
                          value: 328
                        - key: '2'
                          value: 2
                        timestamp: 2024-01-29T08:00:00+0000
                      granularity: DAY
                      name: ENDPOINT_REQUEST_LATENCY_SECONDS_CEIL
                Get Flow:
                  value:
                    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'
                    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'
                Get Preview URL:
                  value:
                    id: flow-1
                    preview:
                      expires_at: 2023-05-21T11:18:09+0000
                      preview_url: https://business.facebook.com/wa/manage/flows/550.../preview/?token=b9d6....
      security:
      - bearerAuth: []
components:
  parameters:
    Authorization:
      name: Authorization
      in: header
      description: 'Bearer token for API authentication. This should be a valid access token obtained through the appropriate OAuth flow or system user token.

        '
      required: true
      schema:
        type: string
        pattern: ^Bearer\s+[A-Za-z0-9\-_.]+.*$
        example: Bearer EAABwzLixnjYBOzYmNMJJGfHq9DgNh...
    UserAgent:
      name: User-Agent
      in: header
      description: The user agent string identifying the client software making the request.
      required: false
      schema:
        type: string
        default: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
        pattern: ^[a-zA-Z0-9\-_]+\/[0-9]+\.[0-9]+\.[0-9]+(;[a-zA-Z0-9\-=\.]+)?(\s+[a-zA-Z0-9\-_]+\/[0-9\-\.]+)?$
        example: Meta-Business-Messaging-OpenAPI/1.0.0;spec=2025-10-21
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'System user access token with whatsapp_business_management permission. Format: Bearer YOUR_SYSTEM_USER_ACCESS_TOKEN

        '