openapi: 3.2.0
info:
  title: Opoint Mailstatus API
  version: 1.0.0
  description: 'Operations tagged mailstatus across 2 of this provider''s published API definitions: opoint-openapi-original.yml, opoint-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.opoint.com
tags:
- name: mailstatus
paths:
  /mailstatus/alert/{alert_id}/:
    get:
      operationId: mailstatus_alert_retrieve
      description: Get all mails for an alert with a given id according to the given mode, start and end timestamp may be also specified
      summary: Get all mails for an alert
      parameters:
      - in: path
        name: alert_id
        schema:
          type: integer
        required: true
      - in: query
        name: time_from
        schema:
          type: integer
        description: Start timestamp of the filtering range
      - in: query
        name: time_to
        schema:
          type: integer
        description: End timestamp of the filtering range
      tags:
      - mailstatus
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertMails'
          description: ''
    servers:
    - url: https://api.opoint.com
  /mailstatus/alert_delays/:
    get:
      operationId: mailstatus_alert_delays_list
      summary: List alert delays
      parameters:
      - in: query
        name: time_from
        schema:
          type: integer
        description: Start timestamp of the filtering range
      - in: query
        name: time_to
        schema:
          type: integer
        description: End timestamp of the filtering range
      tags:
      - mailstatus
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ScheduleItemDelay'
          description: ''
    servers:
    - url: https://api.opoint.com
  /mailstatus/daily_fails/:
    get:
      operationId: mailstatus_daily_fails_list
      description: Try to find mails that have failed today that usually dont fail.
      summary: List today's most important fails
      tags:
      - mailstatus
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MostImportantFails'
          description: ''
    servers:
    - url: https://api.opoint.com
  /mailstatus/recipient/{email}/:
    get:
      operationId: mailstatus_recipient_retrieve
      description: Get all mails for a recipient address with a given id according to the given mode, start and end timestamp may be also specified
      summary: Get all mails for a recipient address
      parameters:
      - in: path
        name: email
        schema:
          type: string
        required: true
      - in: query
        name: time_from
        schema:
          type: integer
        description: Start timestamp of the filtering range
      - in: query
        name: time_to
        schema:
          type: integer
        description: End timestamp of the filtering range
      tags:
      - mailstatus
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RecipientMails'
          description: ''
    servers:
    - url: https://api.opoint.com
  /mailstatus/search/{search_string}/:
    get:
      operationId: mailstatus_search_list
      description: 'Lookup a recipient address, user, or alert. This endpoint uses a cached table that contains information

        that is needed to perform searches in the get_statuses endpoint, and is optimized and is to be used for autocompletion.'
      summary: Search for recipient addresses, users, or alerts containing given substring
      parameters:
      - in: path
        name: search_string
        schema:
          type: string
        required: true
      tags:
      - mailstatus
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MailLookup'
          description: ''
    servers:
    - url: https://api.opoint.com
  /mailstatus/stats/{time_from}/{time_to}/:
    get:
      operationId: mailstatus_stats_list
      description: Return the total mails and fails from our mailserver given a timespan.
      summary: List mails and failures
      parameters:
      - in: path
        name: time_from
        schema:
          type: integer
        required: true
      - in: path
        name: time_to
        schema:
          type: integer
        required: true
      tags:
      - mailstatus
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/MailStats'
          description: ''
    servers:
    - url: https://api.opoint.com
  /mailstatus/status/messages/{value}/:
    get:
      operationId: mailstatus_status_messages_retrieve
      summary: Get mail events for a mail with given id
      parameters:
      - in: path
        name: value
        schema:
          type: string
        required: true
      tags:
      - mailstatus
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GroupedEventMessage'
          description: ''
    servers:
    - url: https://api.opoint.com
  /mailstatus/status/range/{unix_hour}/:
    get:
      operationId: mailstatus_status_range_retrieve
      summary: Get status counts for a given hour
      parameters:
      - in: path
        name: unix_hour
        schema:
          type: string
        required: true
      tags:
      - mailstatus
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AggregatedRange'
          description: ''
    servers:
    - url: https://api.opoint.com
  /mailstatus/status/statuses/{status}/{unix_hour}/:
    get:
      operationId: mailstatus_status_statuses_retrieve
      summary: Get all mails with a specific status sent during a given hour
      parameters:
      - in: query
        name: page
        schema:
          type: integer
        description: Number of the current page
      - in: path
        name: status
        schema:
          type: string
        required: true
      - in: path
        name: unix_hour
        schema:
          type: integer
        required: true
      tags:
      - mailstatus
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/TotalStatusesPaginated'
          description: ''
    servers:
    - url: https://api.opoint.com
  /mailstatus/user/{user_id}/:
    get:
      operationId: mailstatus_user_retrieve
      description: Get all mails for an user with a given id according to the given mode, start and end timestamp may be also specified
      summary: Get all mails for an user
      parameters:
      - in: query
        name: time_from
        schema:
          type: integer
        description: Start timestamp of the filtering range
      - in: query
        name: time_to
        schema:
          type: integer
        description: End timestamp of the filtering range
      - in: path
        name: user_id
        schema:
          type: integer
        required: true
      tags:
      - mailstatus
      security:
      - JWT: []
      - ephmeralId: []
      - staticToken: []
      - cookieAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMails'
          description: ''
    servers:
    - url: https://api.opoint.com
components:
  schemas:
    RecipientMailList:
      type: object
      properties:
        timestamp:
          type: integer
        status:
          type: integer
        subject:
          type: string
        id_mail:
          type: integer
        owner_name:
          type: string
        owner_id:
          type: integer
      required:
      - id_mail
      - owner_id
      - owner_name
      - status
      - subject
      - timestamp
    AggregatedRange:
      type: object
      properties:
        statuses:
          type: array
          items:
            $ref: '#/components/schemas/StatusOverview'
      required:
      - statuses
    TotalStatusesPaginated:
      type: object
      properties:
        previous:
          type:
          - string
          - 'null'
        next:
          type:
          - string
          - 'null'
        results:
          type: array
          items:
            $ref: '#/components/schemas/TotalStatuses'
      required:
      - next
      - previous
      - results
    MailList:
      type: object
      properties:
        timestamp:
          type: integer
        status:
          type: integer
        subject:
          type: string
        id_mail:
          type: integer
      required:
      - id_mail
      - status
      - subject
      - timestamp
    EventMessage:
      type: object
      properties:
        timestamp:
          type: integer
        message:
          type: string
      required:
      - message
      - timestamp
    AlertMails:
      type: object
      properties:
        alert_name:
          type: string
        owner_name:
          type: string
        owner_id:
          type: integer
        mails:
          type: array
          items:
            $ref: '#/components/schemas/MailList'
      required:
      - alert_name
      - mails
      - owner_id
      - owner_name
    MailLookup:
      type: object
      properties:
        value:
          type: string
        searchval:
          type: string
        type_field:
          type: string
          readOnly: true
      required:
      - searchval
      - type_field
      - value
    MailStats:
      type: object
      properties:
        unix_hour:
          type: integer
        mails_total:
          type: integer
        mails_failed:
          type: integer
        recipients_total:
          type: integer
        recipients_failed:
          type: integer
        domains_total:
          type: integer
        domains_failed:
          type: integer
      required:
      - domains_failed
      - domains_total
      - mails_failed
      - mails_total
      - recipients_failed
      - recipients_total
      - unix_hour
    GroupedEventMessage:
      type: object
      properties:
        messages:
          type: array
          items:
            $ref: '#/components/schemas/EventMessage'
      required:
      - messages
    UserMails:
      type: object
      properties:
        name:
          type: string
        mails:
          type: array
          items:
            $ref: '#/components/schemas/MailList'
      required:
      - mails
      - name
    ScheduleItemDelay:
      type: object
      properties:
        id_item:
          type: integer
        ScheduledAt:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
        SendAt:
          type: integer
          maximum: 2147483647
          minimum: -2147483648
      required:
      - ScheduledAt
      - SendAt
      - id_item
    MostImportantFails:
      type: object
      properties:
        alert:
          type: string
        search_value:
          type: integer
        user:
          type: string
        score:
          type: number
          format: double
      required:
      - alert
      - score
      - search_value
      - user
    TotalStatuses:
      type: object
      properties:
        address:
          type: string
        username:
          type: string
        id_user:
          type: integer
        timestamp:
          type: integer
      required:
      - address
      - id_user
      - timestamp
      - username
    RecipientMails:
      type: object
      properties:
        mails:
          type: array
          items:
            $ref: '#/components/schemas/RecipientMailList'
      required:
      - mails
    StatusOverview:
      type: object
      properties:
        status:
          type: integer
        count:
          type: integer
      required:
      - count
      - status
  securitySchemes:
    JWT:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "JWT"
    cookieAuth:
      type: apiKey
      in: cookie
      name: PHPSESSID
    ephmeralId:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Ephemeral"
    staticToken:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
x-refined-from:
- opoint-openapi-original.yml
- opoint-openapi.yml