DID Logic Reports API

openapi: 3.2.0
info:
  title: Didlogic Com Reports API
  version: 1.0.0
  description: 'Operations tagged Reports across 2 of this provider''s published API definitions: didlogic-com-public-api-openapi.yaml, didlogic-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://app.didlogic.com
  description: Production
tags:
- name: Reports
  x-version: v1
paths:
  /api/v1/asr_report:
    get:
      summary: Get ASR (Answer-Seizure Ratio) report
      description: 'Retrieve the Answer-Seizure Ratio (ASR) report in CSV format for specified date range.


        **ASR Metrics:**

        - Number of calls

        - Talk time in minutes

        - ASR: Percentage of calls successfully connected

        - Average call duration (ACD)


        **Requirements:**

        - Date range is required (start_date and end_date)

        - Dates must be in YYYY-MM-DD format

        - On success returns CSV; 400 and 403 errors return JSON'
      tags:
      - Reports
      operationId: asr_report_show
      security:
      - BearerAuth: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
        example: '2024-01-01'
        description: Report start date (YYYY-MM-DD format)
      - name: end_date
        in: query
        required: true
        schema:
          type: string
        example: '2024-12-31'
        description: Report end date (YYYY-MM-DD format)
      responses:
        '200':
          description: Successfully returns ASR metrics report in CSV format
          content:
            text/csv:
              schema:
                type: string
              example: 'Country,Minutes,Calls,ASR,ACD

                '
        '400':
          description: Returns 400 error when end_date or start_date parameter is missing
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                errors:
                  base:
                  - start_date and end_date are required
        '403':
          description: Returns 403 error when the API token is incorrect or the account is not permitted to export the ASR report
          content:
            application/json:
              schema:
                oneOf:
                - $ref: '#/components/schemas/Error'
                - type: object
                  properties:
                    error:
                      type: string
                  required:
                  - error
              examples:
                returns_403_error_when_the_api_token_is_incorrect:
                  summary: Returns 403 error when the API token is incorrect
                  value:
                    error: Unauthorized
                returns_403_error_when_the_api_token_is_incorrect_or_the_account_is_not_permitted_to_export_the_asr_report:
                  summary: Returns 403 error when the API token is incorrect or the account is not permitted to export the ASR report
                  value:
                    errors:
                      base:
                      - ASR report export is not permitted for this account
    servers:
    - url: https://app.didlogic.com
      description: Production
  /api/v1/transactions:
    get:
      summary: Export transaction history
      description: 'Export account transaction history as a CSV file for a date range and

        transaction type(s).


        **Requirements:**

        - start_date, end_date and type are all required

        - Dates must be in YYYY-MM-DD format

        - `type` accepts one or more comma-separated values from the list below


        **Transaction types:** adjustments, paypal_in, paypal_out, cc_in, stripe_in,

        google_pay_in, apple_pay_in, wire_transfer, call, call_fix_fee, connection,

        sip, webcall, sms, inbound_sms, activation, month, subscription, porting,

        surcharge, risk_check, call_recording, hlr_lookup, amd, paid_overstamping,

        service_charge, x_transfer, refund, channel


        `service_charge`, `x_transfer` and `refund` are manual withdrawals booked by

        our accounting team: a fee for a service we provided, a transfer of funds to

        another account, and a refund of funds to you.


        **Response:** The caller receives the generated CSV payload. The internal

        redirect used to fetch that file is an implementation detail and is not

        part of the public contract.'
      tags:
      - Reports
      operationId: transactions_index
      security:
      - BearerAuth: []
      parameters:
      - name: start_date
        in: query
        required: true
        schema:
          type: string
          format: date
          example: '2024-01-01'
        example: '2024-01-01'
        description: Start of the reporting period (YYYY-MM-DD)
      - name: end_date
        in: query
        required: true
        schema:
          type: string
          format: date
          example: '2024-01-31'
        example: '2024-01-31'
        description: End of the reporting period (YYYY-MM-DD)
      - name: type
        in: query
        required: true
        schema:
          type: string
          example: call
        example: call
        description: Comma-separated transaction type(s); see the operation description for the full list of accepted values.
      responses:
        '200':
          description: Returns the generated transactions CSV file
          content:
            text/csv:
              schema:
                type: string
              example: 'Date,Time,Transaction type,Comment,Amount,Balance,Status

                2024-01-15,10:30,call,Sample call charge,-1.23,98.77,completed

                '
        '400':
          description: Returns 400 with the JSON error envelope when required params are missing or malformed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
              example:
                errors:
                  base:
                  - start_date, end_date and type are required
        '403':
          description: Returns 403 error when the API token is incorrect
          content:
            application/json:
              schema:
                type: object
                properties:
                  error:
                    type: string
                required:
                - error
              example:
                error: Unauthorized
    servers:
    - url: https://app.didlogic.com
      description: Production
components:
  schemas:
    Error:
      type: object
      description: Standard error response. `errors` maps a field name (or `base` for errors not tied to a specific field) to an array of human-readable messages.
      required:
      - errors
      properties:
        errors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          example:
            base:
            - data not found
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: Authenticate API requests via API key like "Bearer YOUR_TOKEN"
x-refined-from:
- didlogic-com-public-api-openapi.yaml
- didlogic-com-openapi.yml