Channel99 Intents API

openapi: 3.2.0
info:
  title: Pulsar Intents API
  description: Channel99 Bulk Data Transfer REST API
  version: 1.0.0
servers:
- url: /
tags:
- name: Intents
  description: Buyer intent signal events — `GET /events/intents`
paths:
  /events/intents:
    get:
      tags:
      - Intents
      summary: List intents
      operationId: getIntents
      security:
      - bearerAuth: []
        clientId: []
      parameters:
      - name: x-client-id
        in: header
        required: true
        schema:
          type: string
        description: Client identifier matching the authenticated token
        example: m2m-client-00000000-0000-0000-0000-000000000000
      - $ref: '#/components/parameters/cursor'
      - $ref: '#/components/parameters/listLimit'
      - $ref: '#/components/parameters/filterIntents'
      - $ref: '#/components/parameters/sortIntents'
      responses:
        '200':
          description: A page of intent records
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedIntents'
        '400':
          description: Bad request – missing instance, invalid cursor, invalid filter, invalid sort, or invalid limit
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: Unauthorized – missing or malformed credentials
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: Forbidden – invalid token or client mismatch
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          $ref: '#/components/responses/NotFound'
        '429':
          $ref: '#/components/responses/TooManyRequests'
        '500':
          description: Internal server error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
components:
  parameters:
    sortIntents:
      name: sort
      in: query
      required: false
      description: 'Sort results by a single field using the syntax `sort[<field>]=asc|desc`.


        Sortable fields: `event_date`, `count_impressions`.


        Examples:

        - `sort[event_date]=desc`

        - `sort[count_impressions]=desc`'
      style: form
      explode: true
    cursor:
      name: cursor
      in: query
      required: false
      description: 'Opaque pagination token from the previous response’s `nextCursor`. Omit on the first page.


        Page size is controlled by the `limit` query parameter (default 200, maximum 1000).'
      schema:
        type: string
    listLimit:
      name: limit
      in: query
      required: false
      description: 'Maximum number of records to return in this page.

        Omit to use the default (200); the maximum allowed value is 1000.

        Values above the maximum return HTTP 400 with code `err:pulsar.request.invalid-limit`.'
      schema:
        type: integer
        minimum: 1
        maximum: 1000
    filterIntents:
      name: filter
      in: query
      required: false
      description: 'Filter results by field values using the syntax `filter[<field>][<op>]=<value>`.


        Operators by field type:

        - **string**: `eq`, `ne`, `in`, `notIn`, `isNull`, `isNotNull`

        - **number**: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `in`, `notIn`, `isNull`, `isNotNull`

        - **boolean**: `eq`, `ne`, `isNull`, `isNotNull`

        - **date**: `eq`, `ne`, `gt`, `gte`, `lt`, `lte`, `isNull`, `isNotNull`


        For `in` and `notIn`, provide comma-separated values: `filter[tag_id][in]=a,b,c`.

        For `isNull` and `isNotNull`, the value is ignored.


        Multiple filters are combined with AND.


        Examples:

        - `filter[event_date][gte]=2024-01-01`

        - `filter[company_id][eq]=abc123`

        - `filter[intent_type][eq]=category`

        - `filter[signal_type][isNull]=true`

        - `filter[channel_id][in]=ch1,ch2`'
      style: deepObject
      explode: true
      schema:
        type: object
  responses:
    TooManyRequests:
      description: 'Rate limit exceeded – too many requests from this client.


        Limits:

        - `POST /auth/token`: 20 req/min per `client_id` (app), plus WAF per-IP limit

        - `/events/*` and `/dimensions/*`: burst limit of 100 req / 10s per client (app)

        - All authenticated routes: WAF 60 req/s per `x-client-id` (5-minute window)

        - `/ip/*` routes: WAF elevated tier (app burst limit does not apply)


        App-level limits can be disabled via `PULSAR_APP_RATE_LIMITS=0|false|off` (WAF still applies).'
      headers:
        Retry-After:
          description: Number of seconds to wait before retrying
          schema:
            type: integer
            example: 60
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Not found – no matching route or resource (code `err:pulsar.core.not-found`)
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    PaginatedIntents:
      type: object
      properties:
        data:
          type: array
          items:
            $ref: '#/components/schemas/Intent'
        nextCursor:
          type:
          - string
          - 'null'
          description: Pass as the `cursor` query parameter to fetch the next page, or null when there are no more results.
      required:
      - data
      - nextCursor
    Error:
      type: object
      properties:
        error:
          type: string
          description: Error class name
        code:
          type: string
          description: Machine-readable error code (e.g. `err:pulsar.request.invalid-limit`, `err:pulsar.core.not-found`)
          example: err:pulsar.request.invalid-limit
        message:
          type: string
          description: Human-readable description
      required:
      - error
      - code
      - message
    Intent:
      type: object
      properties:
        intent_event_id:
          type: string
        event_date:
          type: string
          format: date-time
        channel_id:
          type:
          - string
          - 'null'
        vendor_id:
          type:
          - string
          - 'null'
        company_id:
          type: string
        audience_id_list:
          type:
          - array
          - 'null'
          items:
            type: string
        intent_id:
          type: string
        intent_type:
          type:
          - string
          - 'null'
        intent_name:
          type:
          - string
          - 'null'
        signal_type:
          type:
          - string
          - 'null'
        count_impressions:
          type: integer
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: 'M2M Bearer token issued by Stytch. Pass as `Authorization: Bearer <token>`.


        Example: `Authorization: Bearer eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9...`'
    clientId:
      type: apiKey
      in: header
      name: x-client-id
      description: 'Client identifier that must match the `client_id` claim in the Bearer token.


        Example: `x-client-id: m2m-client-00000000-0000-0000-0000-000000000000`'