Ometria Unsubscribes API

openapi: 3.2.0
info:
  version: 1.1.0
  title: Ometria data Unsubscribes API
  description: 'Welcome to the Ometria API reference.


    The Ometria API is organized around the REST methodology, and it uses resource-oriented URLs, and common HTTP response codes to indicate API errors. All requests are authenticated using an API key which can be obtained from your account settings.


    ### HTTPS


    All requests to the Ometria API MUST be carried out via HTTPS. API servers do not listen on unsecured HTTP ports to avoid the possibility of insecure information exchange.


    ### Message encoding


    The V2 Ometria API uses JSON encoding for all data exchanges and assumes UTF-8 character encoding throughout.


    ### Rate limits


    The Ometria API has a default rate limit of 4 requests per second per Ometria account. The /push/ endpoint allows 8 requests per second per Ometria account. If you expect to exceed this limit, please contact us.


    In the case of your application being rate limited, the HTTP code 429 (too many requests) will be returned. In this case your application should reduce the number of requests it is trying to send.'
  contact:
    name: Ometria
    email: support@ometria.com
    url: https://ometria.com
servers:
- url: https://api.ometria.com/v2
security:
- apikey: []
tags:
- name: Unsubscribes
paths:
  /unsubscribes:
    get:
      tags:
      - Unsubscribes
      summary: Receive unsubscribe events within a given time range, across both email and SMS…
      description: 'Email


        The following unsubscribe types are available via the endpoint:


        Preferences centre


        App


        List unsubscribe — when the contact clicks the "unsubscribe" button in their email client.


        Link unsubscribe — when the contact clicks a link formatted for Ometria to recognise.


        SMS


        Two types are available via the endpoint:


        stopword_unsubscribe_TF — unsubscribe via a stop word in an automation campaign.

        stopword_unsubscribe_DO — unsubscribe via a stop word in double opt-in message.


        Not available via the endpoint


        API unsubscribes are not available through this endpoint, for either email or SMS.'
      parameters:
      - name: since
        in: query
        description: The earliest date from which to fetch unsubscribe data. Following time format YYYY-MM-DDTH:I:S in UTC.
        required: false
        schema:
          type: string
      - name: before
        in: query
        description: The latest date from which to fetch unsubscribe data. Following time format YYYY-MM-DDTH:I:S in UTC.
        required: false
        schema:
          type: string
      - name: type
        in: query
        description: The type of unsubscribe event to return.
        required: false
        schema:
          type: string
      responses:
        '200':
          description: An array of unsubscribe objects.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/Unsubscribes'
        '403':
          description: API key is not authorised to access this resource.
      operationId: getUnsubscribes
      x-operation-id-source: derived
components:
  schemas:
    Unsubscribes:
      type: object
      description: Describes an Unsubscribe record.
      properties:
        profile_id:
          type: string
          description: The profile id of the contact whom has unsubscribed.
        email_address:
          type: string
          description: The email address of the contact whom has unsubscribed.
        type:
          type: string
          description: The type of unsubscribe event. This indicates where the contact unsubscribed (e.g., "preferences_centre").
          enum:
          - preferences_centre
          - app
          - list_unsubscribe
          - link_unsubscribe
          - stopword_unsubscribe_TF
          - stopword_unsubscribe_DO
        timestamp:
          type: string
          format: date-time
          description: The timestamp of the unsubscribe event.
        reason:
          type: string
          description: The reason given for unsubscribing.
        reason_text:
          type: string
          description: The reason provided for unsubscribing in the free-text field.
        customer_id:
          type: string
          description: The universal customer ID for this contact.
      example:
        profile_id: 19e53-b37265-160
        email_address: email@example.com
        type: preferences_centre
        timestamp: '2017-05-17 22:08:07+00'
        reason: null
        reason_text: null
        customer_id: '7898734'
  securitySchemes:
    apikey:
      type: apiKey
      name: X-Ometria-Auth
      in: header
      description: Ometria API key which can be obtained from your Ometria account administrator
    apiKeyReadTranslations:
      type: apiKey
      name: X-Ometria-Auth
      in: header
      description: 'Ometria API key which can be obtained from your Ometria account administrator. **Note**: The API key must have the scope `read:translations`.'
    apiKeyWriteTranslations:
      type: apiKey
      name: X-Ometria-Auth
      in: header
      description: 'Ometria API key which can be obtained from your Ometria account administrator. **Note**: The API key must have the scope `write:translations`.'
x-explorer-enabled: false
x-readme:
  proxy-enabled: true
  samples-enabled: true