openapi: 3.2.0
info:
  title: Branch Metrics Analytics API
  version: '2026-10-03'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-10-03: 7 operation(s) read from 5 public documentation page(s) (each operation names its page in x-source). This is not the provider''s published contract; Branch Metrics has published no machine-readable contract that the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 9
    documentation: -2
    pages-with-code: 5
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-10-03'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://help.branch.io/apidocs/app-api.md
  - https://help.branch.io/apidocs/query-api.md
  - https://help.branch.io/apidocs/cohort-api.md
  - https://help.branch.io/apidocs/events-api.md
  - https://help.branch.io/apidocs/qr-code-api.md
servers:
- url: https://api2.branch.io
tags:
- name: Analytics
paths:
  /v2/analytics:
    get:
      operationId: get_v2_analytics
      tags:
      - Analytics
      summary: Export Cohort Analytics
      x-source: https://help.branch.io/apidocs/cohort-api.md
      parameters:
      - name: organization_id
        in: query
        required: true
        schema:
          type: string
        description: Unique identifier for the organization of requested data.
      - name: app_id
        in: query
        required: true
        schema:
          type: string
        description: Unique identifier for the organization of requested data.
      - name: Access-Token
        in: header
        required: true
        schema:
          type: string
        description: Key that encapsulates the user's permission with regards to an organization.
      - name: accept
        in: header
        required: false
        schema:
          type: string
        description: application/json
      - name: content-type
        in: header
        required: false
        schema:
          type: string
        description: application/json
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV2AnalyticsResponse'
      x-evidence:
        kind: documentation
  /v2/analytics/{jobid}:
    get:
      operationId: get_v2_analytics_jobid
      tags:
      - Analytics
      summary: GET /v2/analytics/{jobId}
      x-source: https://help.branch.io/apidocs/cohort-api.md
      parameters:
      - name: jobid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
      x-evidence:
        kind: code-example
        language: curl
        snippet: 'curl

          curl ''https://api2.branch.io/v2/analytics/<job_id>?organization_id=<organization_id>'' -H ''Access-Token:<branch_access_token>''

          ```'
components:
  schemas:
    GetV2AnalyticsResponse:
      type: object
      properties:
        job_id:
          type: string
          description: Unique identifier used to retrieve job status and data.
        code:
          type: string
          description: The HTTP response code.
        status_url:
          type: string
          description: The URL of the export request.
        error_message:
          type: string
          description: Error message. Only present if the query failed.