> ## Documentation Index
> Fetch the complete documentation index at: https://docs.metricanic.com/llms.txt
> Use this file to discover all available pages before exploring further.

# List events

> Raw event stream for inspection and debugging - visits, landing page clicks, conversion events and outbound postbacks. Uses cursor pagination: pass meta.nextCursor back via the cursor parameter while hasMore is true. Rows include request-level fields (requestIp, requestUa, requestReferer) captured from your own tracked traffic - treat responses as sensitive and query server-side. This endpoint is backed by the analytical store and can respond 503 while data is temporarily unavailable.



## OpenAPI

````yaml openapi.public.yaml GET /api/v1/events
openapi: 3.0.3
info:
  title: Metricanic API
  version: 1.0.0
  description: >
    # Metricanic API


    Use the Metricanic REST API to manage campaigns, traffic sources, affiliate
    networks, landings, offers and rotators, and to read performance reports and
    individual events.


    Base URL: `https://panel.metricanic.com/api/v1`. Requests require an
    account-scoped Bearer key created in **Profile → API keys**. Use `read` for
    GET requests or `write` for supported mutations. Keys are intended for
    server-side integrations. Cross-origin browser writes are rejected.


    Start with the [API
    quickstart](https://docs.metricanic.com/api-reference/introduction), then
    follow the guides for
    [authentication](https://docs.metricanic.com/api-reference/authentication),
    [reports and event
    pagination](https://docs.metricanic.com/api-reference/reports-and-events),
    and [errors and retries](https://docs.metricanic.com/api-reference/errors).


    Only the operations in this specification are supported under `/api/v1`.
    Individual endpoint schemas define the request and response shapes. List
    endpoints do not all share the same pagination model. The product's OAuth
    MCP connection has separate, read-only capabilities.
  license:
    name: Proprietary
    url: https://metricanic.com/legal/terms
servers:
  - url: https://panel.metricanic.com
security:
  - bearerAuth: []
tags:
  - name: Auth
    description: Authentication and session endpoints.
  - name: Campaigns
    description: Campaign and campaign-related management endpoints.
  - name: Landings
    description: Landing page management endpoints.
  - name: Offers
    description: Offer management endpoints.
  - name: Reports
    description: Aggregated reporting and chart endpoints.
  - name: Rotators
    description: Rotator setup and routing-rule endpoints.
  - name: TrafficSources
    description: Traffic source configuration endpoints.
  - name: AffiliateNetworks
    description: Affiliate network management endpoints.
  - name: Events
    description: Raw event and error inspection endpoints.
paths:
  /api/v1/events:
    get:
      tags:
        - Events
      summary: List events
      description: >-
        Raw event stream for inspection and debugging - visits, landing page
        clicks, conversion events and outbound postbacks. Uses cursor
        pagination: pass meta.nextCursor back via the cursor parameter while
        hasMore is true. Rows include request-level fields (requestIp,
        requestUa, requestReferer) captured from your own tracked traffic -
        treat responses as sensitive and query server-side. This endpoint is
        backed by the analytical store and can respond 503 while data is
        temporarily unavailable.
      operationId: listEvents
      parameters:
        - in: query
          name: campaignId
          description: Comma-separated campaign ids to filter by.
          schema:
            type: string
        - in: query
          name: trafficSourceId
          description: Comma-separated traffic source ids to filter by.
          schema:
            type: string
        - in: query
          name: rotatorId
          description: Comma-separated rotator ids to filter by.
          schema:
            type: string
        - in: query
          name: rotatorPathId
          description: Comma-separated rotator path ids to filter by.
          schema:
            type: string
        - in: query
          name: requestIp
          description: Comma-separated visitor IP addresses to filter by.
          schema:
            type: string
        - in: query
          name: requestUa
          description: Comma-separated User-Agent values to filter by (exact match).
          schema:
            type: string
        - in: query
          name: requestReferer
          description: Comma-separated referrer URLs to filter by (exact match).
          schema:
            type: string
        - in: query
          name: from
          required: true
          schema:
            type: string
        - in: query
          name: to
          required: true
          schema:
            type: string
        - in: query
          name: timezone
          schema:
            type: string
        - in: query
          name: limit
          schema:
            type: integer
        - in: query
          name: mode
          description: >-
            Optional explicit value `scroll` for cursor pagination (default
            behavior).
          schema:
            type: string
            enum:
              - scroll
        - in: query
          name: cursor
          description: Opaque cursor token from previous response.
          schema:
            type: string
        - in: query
          name: idx
          schema:
            type: integer
        - in: query
          name: type
          schema:
            type: string
            enum:
              - visit
              - lpclick
              - event
              - postback
      responses:
        '200':
          description: Event list
          content:
            application/json:
              example:
                ok: true
                data:
                  meta:
                    limit: 100
                    hasMore: false
                    nextCursor: null
                  rows:
                    - id: 0197f3a2-b4c5-7000-8000-000000000001
                      clickTime: 1751362800000
                      visitId: 0197f3a2-b4c5-7000-8000-00000000000a
                      externalId: src-click-8842
                      campaignId: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                      trafficSourceId: 6f9d2b4e-8a1c-4d3e-9f5a-7b2c4d6e8f0a
                      rotatorId: 9b8c7d6e-5f4a-4b3c-8d1e-0f9a8b7c6d5e
                      rotatorPathId: 5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e
                      type: visit
                      eventTime: 1751362800000
                      deltaMs: 0
                      requestIp: 203.0.113.42
                      requestUa: Mozilla/5.0 (Linux; Android 14) AppleWebKit/537.36
                      requestReferer: https://ads.example.com/feed
                    - id: 0197f3a2-b4c5-7000-8000-000000000002
                      clickTime: 1751362800000
                      visitId: 0197f3a2-b4c5-7000-8000-00000000000a
                      externalId: src-click-8842
                      campaignId: 1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d
                      trafficSourceId: 6f9d2b4e-8a1c-4d3e-9f5a-7b2c4d6e8f0a
                      rotatorId: 9b8c7d6e-5f4a-4b3c-8d1e-0f9a8b7c6d5e
                      rotatorPathId: 5b6c7d8e-9f0a-4b1c-8d2e-3f4a5b6c7d8e
                      type: event
                      eventTime: 1751363115000
                      deltaMs: 315000
                      idx: 0
                      payout: 4.5
                      value: 4.5
                      affectsRevenue: true
              schema:
                $ref: '#/components/schemas/EventListResponse'
        '400':
          description: Bad request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '429':
          description: Scroll budget exceeded when request cannot safely advance cursor.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
        '503':
          $ref: '#/components/responses/ServiceUnavailableError'
        default:
          $ref: '#/components/responses/ErrorResponse'
components:
  schemas:
    EventListResponse:
      type: object
      properties:
        ok:
          type: boolean
          enum:
            - true
        data:
          type: object
          properties:
            meta:
              $ref: '#/components/schemas/EventListMetaScroll'
            rows:
              type: array
              items:
                $ref: '#/components/schemas/EventRow'
      required:
        - ok
        - data
      additionalProperties: false
    ErrorResponse:
      type: object
      properties:
        ok:
          type: boolean
          enum:
            - false
        error:
          type: object
          properties:
            code:
              type: string
            message:
              type: string
            details:
              type: object
              additionalProperties: true
          required:
            - code
            - message
          additionalProperties: false
        requestId:
          type: string
      required:
        - ok
        - error
      additionalProperties: false
    EventListMetaScroll:
      type: object
      properties:
        limit:
          type: integer
        hasMore:
          type: boolean
        nextCursor:
          type: string
          nullable: true
      required:
        - limit
        - hasMore
        - nextCursor
    EventRow:
      type: object
      properties:
        id:
          type: string
        clickTime:
          type: integer
        visitId:
          type: string
        externalId:
          type: string
          nullable: true
        campaignId:
          type: string
          nullable: true
        trafficSourceId:
          type: string
          nullable: true
        rotatorId:
          type: string
          nullable: true
        rotatorPathId:
          type: string
          nullable: true
        type:
          type: string
          enum:
            - visit
            - lpclick
            - event
            - postback
        eventTime:
          type: integer
        deltaMs:
          type: integer
        requestIp:
          type: string
          nullable: true
          description: >-
            Visitor IP address captured by the tracker (the tenant's own traffic
            data).
        requestUa:
          type: string
          nullable: true
          description: Visitor User-Agent string captured by the tracker.
        requestReferer:
          type: string
          nullable: true
          description: Referrer URL captured on the tracked request.
        idx:
          type: integer
          nullable: true
        payout:
          type: number
          nullable: true
        cost:
          type: number
          nullable: true
        value:
          type: number
          nullable: true
        affectsCost:
          type: boolean
          nullable: true
        affectsRevenue:
          type: boolean
          nullable: true
        postbackStatus:
          type: integer
          nullable: true
        postbackBody:
          type: string
          nullable: true
        postbackError:
          type: string
          nullable: true
        postbackTry:
          type: integer
          nullable: true
        postbackDuration:
          type: integer
          nullable: true
        postbackUrl:
          type: string
          nullable: true
        postbackSuccess:
          type: boolean
          nullable: true
  responses:
    ServiceUnavailableError:
      description: A required platform dependency is temporarily unavailable.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
    ErrorResponse:
      description: >-
        Standard API error envelope. Common platform errors include
        authentication failures, forbidden scope or origin, billing gate, rate
        limiting, and temporary service unavailability.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ErrorResponse'
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT

````