Basiq

Basiq Analytics API

The Analytics API from Basiq — 2 operation(s) for analytics.

GitHub OpenAPI

Operations 2

GET /analytics/users User Analytics #
GET /analytics/connections Connection Analytics #

Documentation

📖
Documentation
https://api.basiq.io/reference

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/openapi/basiq-analytics-api-openapi.yml

Schemas & Data

📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-single-merchant-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-merchant-details-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-webhook-stats-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-post-insights-request-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-post-insights-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-insight-type-item-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-insight-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-account-insight-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-expense-ratio-insight-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-connection-analytics-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-analytics-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-payee-details-response-schema.json
📊
JSONSchema
https://raw.githubusercontent.com/api-evangelist/basiq/refs/heads/main/json-schema/basiq-payees-list-response-schema.json

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API 
curl "https://apis.io/api/v1/apis/basiq:basiq-analytics-api"
All apis 
curl "https://apis.io/api/v1/apis?limit=25"

Discovery needs no key. Ratings and market analysis are Pro.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

basiq-analytics-api-openapi.yml Raw ↑ 
openapi: 3.2.0
info:
  title: Core Analytics API
  description: All included utility endpoints for Basiq partners
  version: 3.0.0
  termsOfService: https://docs.basiq.io/en/collections/440849-privacy-terms-and-common-questions
  license:
    name: Commercial
    url: https://basiq.io
servers:
- url: https://au-api.basiq.io
tags:
- name: Analytics
paths:
  /analytics/users:
    get:
      tags:
      - Analytics
      operationId: getUserAnalytics
      summary: User Analytics
      description: Retrieve user analytics, such as number of users and connections created for an application over a given time interval.
      parameters:
      - name: interval
        in: query
        required: true
        schema:
          type: string
          enum:
          - daily
          - weekly
          - monthly
          - quarterly
          - annually
        description: Time interval for analytics.
      - name: fromDate
        in: query
        required: false
        schema:
          type: string
          format: date
        description: Start date of the analytics period (e.g., 2023-01-01).
      - name: toDate
        in: query
        required: false
        schema:
          type: string
          format: date
        description: End date of the analytics period (e.g., 2024-01-01).
      - name: connectionType
        in: query
        required: false
        schema:
          type: string
          description: Comma-separated list of case-sensitive connection types to filter by.
          example: all,cdr,pdf,web,csv
        description: 'Filter analytics by one or more connection types. Must be a comma-separated string. Values are case-sensitive: all, cdr, pdf, web, csv.'
      responses:
        '200':
          description: Successful analytics response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AnalyticsResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '401':
          description: Unauthorized - missing or invalid token
        '403':
          description: Access denied - expired or invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '500':
          description: Internal server error
      security:
      - services_token: []
  /analytics/connections:
    get:
      tags:
      - Analytics
      operationId: getConnectionAnalytics
      summary: Connection Analytics
      description: Retrieve connection analytics, including connection creation, status distribution, method distribution, and disruption rates over a given time interval.
      parameters:
      - name: interval
        in: query
        required: true
        schema:
          type: string
          enum:
          - daily
          - weekly
          - monthly
          - quarterly
          - annually
        description: Time interval for analytics.
      - name: fromDate
        in: query
        required: false
        schema:
          type: string
          format: date
        description: Start date of the analytics period (e.g., 2023-01-01).
      - name: toDate
        in: query
        required: false
        schema:
          type: string
          format: date
        description: End date of the analytics period (e.g., 2024-01-01).
      responses:
        '200':
          description: Successful connection analytics response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ConnectionAnalyticsResponse'
        '400':
          description: Invalid request parameters
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '401':
          description: Unauthorized - missing or invalid token
        '403':
          description: Access denied - expired or invalid token
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorList'
        '500':
          description: Internal server error
      security:
      - services_token: []
components:
  schemas:
    ErrorItem:
      type: object
      properties:
        type:
          type: string
          enum:
          - error
        code:
          type: string
        title:
          type: string
        detail:
          type: string
        source:
          type:
          - object
          - 'null'
          properties:
            parameter:
              type: string
    StatusDistribution:
      type: object
      properties:
        successful:
          type: integer
        pending:
          type: integer
        failed:
          type: integer
    ConnectionAnalyticsResponse:
      type: object
      properties:
        interval:
          type: string
        fromDate:
          type: string
          format: date
        toDate:
          type: string
          format: date
        meta:
          type: object
          properties:
            totalRecords:
              type: integer
            page:
              type: integer
            pageSize:
              type: integer
        initial:
          type: object
          properties:
            created:
              type: object
              properties:
                count:
                  type: integer
                methodDistribution:
                  $ref: '#/components/schemas/MethodDistribution'
        data:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
              disruptionRate:
                type: string
              created:
                type: object
                properties:
                  count:
                    type: integer
                  methodDistribution:
                    $ref: '#/components/schemas/MethodDistribution'
              nonDeleted:
                type: object
                properties:
                  count:
                    type: integer
                  statusDistribution:
                    type: object
                    properties:
                      successful:
                        type: integer
                      pending:
                        type: integer
                      failed:
                        type: integer
                  methodDistribution:
                    type: object
                    properties:
                      CDR:
                        $ref: '#/components/schemas/StatusDistribution'
                      CSV:
                        $ref: '#/components/schemas/StatusDistribution'
                      PDF:
                        $ref: '#/components/schemas/StatusDistribution'
                      WEB:
                        $ref: '#/components/schemas/StatusDistribution'
    AnalyticsResponse:
      type: object
      properties:
        interval:
          type: string
        fromDate:
          type: string
          format: date
        toDate:
          type: string
          format: date
        meta:
          type: object
          properties:
            totalRecords:
              type: integer
            page:
              type: integer
            pageSize:
              type: integer
        initial:
          type: object
          properties:
            created:
              type: integer
            deleted:
              type: integer
        data:
          type: array
          items:
            type: object
            properties:
              date:
                type: string
                format: date
              created:
                type: integer
              deleted:
                type: integer
              active:
                type: object
                properties:
                  total:
                    type: integer
                  connected:
                    type: object
                    properties:
                      total:
                        type: integer
                      distribution:
                        type: object
                        properties:
                          CDR:
                            type: integer
                          WEB:
                            type: integer
                          PDF:
                            type: integer
                          CSV:
                            type: integer
    MethodDistribution:
      type: object
      properties:
        CDR:
          type: integer
        CSV:
          type: integer
        PDF:
          type: integer
        WEB:
          type: integer
    ErrorList:
      type: object
      properties:
        type:
          type: string
        correlationId:
          type: string
          format: uuid
        data:
          type: array
          items:
            $ref: '#/components/schemas/ErrorItem'
  securitySchemes:
    services_token:
      type: http
      scheme: bearer
      bearerFormat: JWT