Skip to content
SphericonSphericon docs

Export_events

GET
/export/events
curl --request GET \
  --url 'http://localhost:3000/api/export/events?limit=1000' \
  --header 'Authorization: Bearer <token>'

Read the Workspace’s Events, oldest change first (Enterprise; needs the export:read scope). Each line of the body is an ExportEventRow; every key is always present.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
cursor
string

Cursor from the X-Next-Cursor header of a previous page; empty reads from the beginning

limit
integer format: int32
default: 1000 >= 1 <= 10000

Page size

Responses

Section titled “Responses”

200

Section titled “200”

One page of an Export stream (Enterprise, ADR 0045): newline-delimited JSON, one row per line with no envelope, so the body loads as ClickHouse JSONEachRow. The row schema is named by each operation. The next cursor is the X-Next-Cursor header; pass it as cursor for the next page. The cursor is the position after the last row of the page and the next page includes everything at or after it, so rows that share an updated_at across a page edge are not lost. A page with no rows returns the cursor it was given. A row that changes is delivered again with a newer updated_at: keep the newest version per id.

Media typeapplication/x-ndjson
string format: binary

Example generated

binary

Headers

Section titled “Headers”
X-Next-Cursor
required
string

Opaque cursor for the next page

400

Section titled “400”

RFC 7807 bad request response

Media typeapplication/problem+json

RFC 7807 Problem Details

object
code

Why the request was refused, when the client should act on it

string
Allowed values: second_factor_required email_verification_required signup_closed
type

A URI reference that identifies the problem type

string
title

A short, human-readable summary of the problem type

string
status

HTTP status code

integer format: int32
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
errors

Validation errors grouped by field

object
key
additional properties
Array<string>
form

Form-level validation error

string
fields

Field validation errors

object
key
additional properties
string
retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32
debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object
error
required

The error that failed the request, or the panic value

string
stack

The goroutine stack of a panic; absent for an error a handler returned

string
requestId

The request id the server log carries for this request

string
method
required

The HTTP method of the failed request

string
path
required

The path of the failed request

string

Example 

{
  "code": "second_factor_required"
}

401

Section titled “401”

RFC 7807 unauthorized response

Media typeapplication/problem+json

RFC 7807 Problem Details

object
code

Why the request was refused, when the client should act on it

string
Allowed values: second_factor_required email_verification_required signup_closed
type

A URI reference that identifies the problem type

string
title

A short, human-readable summary of the problem type

string
status

HTTP status code

integer format: int32
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
errors

Validation errors grouped by field

object
key
additional properties
Array<string>
form

Form-level validation error

string
fields

Field validation errors

object
key
additional properties
string
retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32
debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object
error
required

The error that failed the request, or the panic value

string
stack

The goroutine stack of a panic; absent for an error a handler returned

string
requestId

The request id the server log carries for this request

string
method
required

The HTTP method of the failed request

string
path
required

The path of the failed request

string

Example 

{
  "code": "second_factor_required"
}

404

Section titled “404”

RFC 7807 not found response

Media typeapplication/problem+json

RFC 7807 Problem Details

object
code

Why the request was refused, when the client should act on it

string
Allowed values: second_factor_required email_verification_required signup_closed
type

A URI reference that identifies the problem type

string
title

A short, human-readable summary of the problem type

string
status

HTTP status code

integer format: int32
detail

A human-readable explanation specific to this occurrence

string
instance

A URI reference that identifies the specific occurrence

string
errors

Validation errors grouped by field

object
key
additional properties
Array<string>
form

Form-level validation error

string
fields

Field validation errors

object
key
additional properties
string
retryAfter

Seconds to wait before retrying; set on a 429 so a client that only sees the body can show the wait

integer format: int32
debug

Why a 500 happened, sent only by a development server (SPHERICON_ENV=development)

object
error
required

The error that failed the request, or the panic value

string
stack

The goroutine stack of a panic; absent for an error a handler returned

string
requestId

The request id the server log carries for this request

string
method
required

The HTTP method of the failed request

string
path
required

The path of the failed request

string

Example 

{
  "code": "second_factor_required"
}