ProsperStack Events API

openapi: 3.2.0
info:
  title: ProsperStack API Reference Events API
  version: v1
  description: 'This is the reference documentation for the ProsperStack API v1. Visit ProsperStack at prosperstack.com.


    For more information on ProsperStack features, see the primary documentation.


    Let us know how we can improve the API, documentation or anything else you need help with at support@prosperstack.com.


    # Introduction


    The ProsperStack API provides a REST-like interface to your ProsperStack data. It uses standard HTTP verbs, accepts JSON-encoded request bodies and provides JSON-encoded responses.


    You can use the ProsperStack API to access your live production data or data from test mode. The API key you use to authenticate requests determines which mode will be used.


    # Authentication


    The ProsperStack API uses API keys to authenticate requests. You can manage your API keys from the ProsperStack API Keys settings page.


    Live mode API keys have the prefix `key_` and test mode API keys have the prefix `key_test_`.


    Authentication uses HTTP basic authentication. Provide your API key as the basic authentication username. You don''t need to provide a password.


    A simple example using cURL:


    ```bash

    curl https://api.prosperstack.com/v1/flow_sessions \

    -u key_LSdJXBrN3SP7bdJrQSMp2eZK:

    ```


    Learn more about creating API keys.


    # Pagination


    All list endpoints support cursor-based pagination. The body of a list response will contain a `data` property with an array of objects and a `next_cursor` property desginating the cursor value to retrieve the next set of results.


    Use the value of `next_cursor` in the `cursor` query parameter to specify the set of results to return. If `next_cursor` is `null`, there are no more results.


    You can also specify a `limit` in the query parameters to adjust the number of items per result set. The limit defaults to 10 and has a maximum of 100.


    # Rate limits


    The ProsperStack API enforces a rate limit of 100 requests per minute. Your live mode and test mode accounts have separate limits.


    When the rate limit is exceeded, requests will fail with the HTTP status `429 Too Many Requests` until the limit window resets.


    The ProsperStack API implements the RateLimit Header Fields for HTTP draft which describes a set of HTTP headers you can use to observe current request limits.


    The headers are:


    - `RateLimit-Limit` — The limit of requests per time window (1 minute)

    - `RateLimit-Remaining` — The number of requests left before exceeding the limit

    - `RateLimit-Reset` — The number of seconds until the limit window resets


    If you need to exceed the rate limit, let us know at support@prosperstack.com and we''ll be happy to help.'
  x-logo:
    url: https://prosperstack.com/images/logo-api.svg
servers:
- url: https://api.prosperstack.com/v1
security:
- basicAuth: []
tags:
- name: Events
  x-displayName: Events
  description: 'An event represents a ProsperStack event that occurred in your account. These are the same events that are delivered via configured webhooks.


    The events endpoints can be used as an alternative or in addition to webhooks. Use the events endpoints if you would like to poll for new events rather than receiving them in real-time, or to catch up on any events a webhook endpoint may have missed.


    Use the event `id` property to determine if your application has handled the event before.


    Note that the events endpoints are only guaranteed to maintain event history for 30 days.'
paths:
  /events:
    get:
      summary: List events
      operationId: listEvents
      parameters:
      - name: after_id
        in: query
        description: Filter events occurring after the specified ID
        schema:
          type: string
      - name: event
        in: query
        description: Filter events by event type (`flow_session_started`, `flow_session_completed`)
        schema:
          type: string
      - name: created_at
        in: query
        description: 'Filter events by the `created_at` property. Specify as a dictionary with one or more of the following properties:


          - `created_at[gt]` — Return events where `created_at` is greater than this value

          - `created_at[lt]` — Return events where `created_at` is less than this value

          - `created_at[gte]` — Return events where `created_at` is greater than or equal to this value

          - `created_at[lte]` — Return events where `created_at` is less than or equal to this value


          Specify date values in [ISO 8601](https://en.wikipedia.org/wiki/ISO_8601) format.

          '
        schema:
          type: string
      - name: cursor
        in: query
        description: Pagination cursor to retrieve
        schema:
          type: string
      - name: limit
        in: query
        description: Limit of events to return
        schema:
          type: integer
          minimum: 1
          maximum: 100
      tags:
      - Events
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                type: object
                required:
                - data
                properties:
                  data:
                    type: array
                    items:
                      $ref: '#/components/schemas/Event'
                  next_cursor:
                    $ref: '#/components/schemas/Cursor'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/Error'
  /events/{id}:
    get:
      summary: Retrieve an event
      operationId: retrieveEventById
      parameters:
      - name: id
        in: path
        description: Event ID to retrieve
        required: true
        schema:
          type: string
      tags:
      - Events
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Event'
        '401':
          description: Unauthorized
          $ref: '#/components/responses/Error'
        '404':
          description: Not Found
          $ref: '#/components/responses/Error'
components:
  responses:
    Error:
      description: Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: string
    Event:
      type: object
      required:
      - id
      - event
      - data
      - created_at
      properties:
        id:
          type: string
          example: evt_ujO4n2g2QbWtGUVg1zJSbC5I
        event:
          type: string
          enum:
          - flow_session_started
          - flow_session_completed
          example: flow_session_completed
        data:
          type: object
          description: The payload of the event.
        created_at:
          type: string
          format: date-time
    Cursor:
      type:
      - string
      - 'null'
      example: 'null'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic