Dashbot

Dashbot Export API

Read API for enriched conversational data. GET /export returns a zipFile handle for all dimension data across a set of bot IDs over a date range, optionally filtered to named prompts; GET /index is the entry point that lists the endpoints available to the key. Authenticated with an API key in the Authorization header. 2 operations.

GitHub OpenAPI

Documentation

📖
Authentication
https://raw.githubusercontent.com/api-evangelist/dashbot/refs/heads/main/authentication/dashbot-authentication.yml
📖
RateLimits
https://raw.githubusercontent.com/api-evangelist/dashbot/refs/heads/main/rate-limits/dashbot-rate-limits.yml

Specifications

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

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/dashbot/refs/heads/main/overlays/dashbot-export-api-overlay.yaml
🔗
ErrorCatalog
https://raw.githubusercontent.com/api-evangelist/dashbot/refs/heads/main/errors/dashbot-problem-types.yml
🔗
DataModel
https://raw.githubusercontent.com/api-evangelist/dashbot/refs/heads/main/data-model/dashbot-data-model.yml
🔗
Conventions
https://raw.githubusercontent.com/api-evangelist/dashbot/refs/heads/main/conventions/dashbot-conventions.yml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/dashbot/refs/heads/main/apis.yml

OpenAPI Specification

dashbot-export-api-openapi.yml Raw ↑ 
openapi: 3.0.0
info:
  version: 1.0.0
  title: Export API
servers:
- url: https://api.dimensionlabs.io
tags:
- name: Export
paths:
  /index:
    get:
      summary: New Endpoint
      description: This is your first endpoint! Edit this page to start documenting your API.
      operationId: get_new-endpoint
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  _links:
                    type: string
                    format: json
                    description: A collection of links to other endpoints this API supports.
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                    description: A message dictating what went wrong with this request
      parameters:
      - in: header
        name: Authorization
        schema:
          type: string
        required: true
        description: Required location for API Key.  See description for how to find your key.
      tags:
      - Export
  /export:
    get:
      description: ''
      operationId: get_export
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  zipFile:
                    type: string
                required:
                - zipFile
        '403':
          description: Forbidden
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
      parameters:
      - in: header
        name: Authorization
        schema:
          type: string
        description: Required location for API Key.  See description for how to find your key.
        required: true
      - in: query
        name: startDate
        schema:
          type: string
        required: true
        description: Required - Start Date in UNIX Milliseconds, YYYY-MM-DD or YYYY-DD-MM.  Inclusive.
      - in: query
        name: endDate
        schema:
          type: string
        required: true
        description: Required - End Date in UNIX Milliseconds, YYYY-MM-DD or YYYY-DD-MM. Exclusive.
      - in: query
        name: botIds
        schema:
          type: string
          default: 1,2,3
        required: true
        description: Comma-separated list of bot ids
      - in: query
        name: promptNames
        schema:
          type: string
        description: Comma-separated list of prompt names
      tags:
      - Export
x-readme:
  explorer-enabled: true
  proxy-enabled: true