OCoctaneai
exports

Request an export

post/v1/exports

Request

  • Base URL
    https://api.octaneai.com
  • Auth
    HTTP bearer

Request body

quiz_idstring nullable

Only this quiz (profiles and responses)

fromstring date nullable

First day, inclusive, UTC

tostring date nullable

Last day, inclusive, UTC

tzstring nullable

quiz_analytics only: the timezone the days are counted in

dataset'profiles' | 'responses' | 'quiz_analytics' required

profiles or responses need profiles:read; quiz_analytics needs analytics:read

format'csv' | 'json'

csv: one row per line behind a UTF-8 byte-order mark; json: one object {dataset, filters, generated_at, items} whose items are the rows as the API returns them

Example request

{
  "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
  "search": {
    "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
    "groups": [
      {
        "all": [
          {
            "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7"
          }
        ]
      }
    ]
  }
}

Response

The export is queued. Poll urls.self until status is completed, then follow download_url.

idstring required

The export

dataset'profiles' | 'responses' | 'quiz_analytics' | 'audit_events' required

What the file holds

format'csv' | 'json' required

The file's format

source'api' | 'dashboard' required

Where the export was requested

status'pending' | 'running' | 'completed' | 'failed' | 'expired' required

pending | running | completed | failed | expired

row_countinteger nullable required

Rows in the file; null until completed

bytesinteger nullable required

The file's size in bytes; null until completed

errorstring nullable required

Why the build failed; null otherwise

requested_atstring date-time required

When the export was requested

started_atstring date-time nullable required

When the build started; null before

completed_atstring date-time nullable required

When the file was ready; null before

expires_atstring date-time required

When the export and its file are deleted

download_urlstring nullable

Set on GET /v1/exports/{export_id} while completed; valid 15 minutes

download_url_expires_atstring date-time nullable

When download_url stops working; null with it

urlsobject required

self: this export on the API; fetch it for a fresh download link

Example response

{
  "id": "exp_7c9e6679742540de944be07fc1f90ae7",
  "filters": {
    "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
    "search": {
      "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7",
      "groups": [
        {
          "all": [
            {
              "quiz_id": "quiz_7c9e6679742540de944be07fc1f90ae7"
            }
          ]
        }
      ]
    }
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.