Skip to content
Praxrr

Export the timeline

GET
/timeline/export
curl --request GET \
  --url 'https://example.com/api/v1/timeline/export?format=json&scopeKind=arr-instance&arrType=radarr&status=success'

Streams the filtered timeline (same filters and source-gating as the list endpoint, no pagination) as a JSON array or CSV file download. Capped server-side to guard memory.

Parameters

Section titled “Parameters”

Query Parameters

Section titled “Query Parameters”
format
string
default: json
Allowed values: json csv
source
Array<string>
Allowed values: sync canary snapshot rollback
scopeKind

Which instance axis an event is scoped to.

string
Allowed values: arr-instance pcd-database
instanceId
integer
databaseId
integer
arrType
string
Allowed values: radarr sonarr lidarr
status

Normalized, cross-source status used for filtering and badge colour.

string
Allowed values: success partial failed skipped pending info
from
string
to
string
q
string

Responses

Section titled “Responses”

200

Section titled “200”

Timeline export

Array<object>

A single normalized timeline event with inline annotations.

object
id
required

Stable composite key ${source}:${sourceId}.

string
source
required

The event source a timeline event originates from.

string
Allowed values: sync canary snapshot rollback
sourceId
required
integer
timestamp
required

ISO-8601 UTC event time (normalized across source dialects).

string format: date-time
type
required

Source-specific subtype (e.g. the trigger).

string
nullable
status
required

Normalized, cross-source status used for filtering and badge colour.

string
Allowed values: success partial failed skipped pending info
badge
required

Badge variant used to colour the event row.

string
Allowed values: success warning danger neutral info
scope
required

Where an event happened. id is null when the Arr instance was deleted; label is retained.

object
kind
required

Which instance axis an event is scoped to.

string
Allowed values: arr-instance pcd-database
id
required
integer
nullable
label
required
string
nullable
arrType
required
string
Allowed values: radarr sonarr lidarr
title
required
string
metrics
required

Small source-specific bag of counts sufficient to render the row.

object
key
additional properties
One of:
string
detailHref
required

Deep-link into the owning feature’s existing detail surface.

string
annotations
required
Array<object>

A user note attached to a single timeline event.

object
id
required
integer
source
required

The event source a timeline event originates from.

string
Allowed values: sync canary snapshot rollback
eventId
required
integer
body
required
string
authorUserId
required
integer
nullable
authorName
required
string
nullable
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
Example
[
  {
    "source": "sync",
    "status": "success",
    "badge": "success",
    "scope": {
      "kind": "arr-instance",
      "arrType": "radarr"
    },
    "annotations": [
      {
        "source": "sync"
      }
    ]
  }
]

400

Section titled “400”

Invalid query parameter or contradictory scope combination

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}

500

Section titled “500”

Failed to export timeline

Media typeapplication/json
object
error
required

Error message

string
Examplegenerated
{
  "error": "example"
}