Docs
Search…
Replays

GET /v1/replay

Description

Get all (non-archived) replays.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

GET /v1/replayer/history/{id}

Description
Get history for specific replay.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Path Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

PUT /v1/replay/{id}/toggle-pause

Description

Pause an in-flight replay.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Path Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

DELETE /v1/replay

Description

Delete a replay.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Body Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

GET /v1/replay/{id}

Description

Get information about a replay.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Path Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

PUT /v1/replay

Description

Update a single replay.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Body Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

DELETE /v1/replay/{id}

Description

Archive/delete a replay.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Path Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

POST /v1/replay

Description

Create a new replay
Type can be "onetime" or "continuous".

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Body Parameters

Param
Type
Required
Description
name
string
yes
Give your Replay a name so you can identify it later
collection_id
string
yes
Where you do you want to get the events from?
destination_id
string
yes
Where do you want the events to go?
query
string
yes
What events do you want? (Lucene query)
type
string
yes
= 'single'
team_id
string
no
Your team id

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}

PUT /v1/replay/{id}/redo

Description

Redo a replay. Will create a new replay using the same search query.

Header Parameters

Param
Type
Required
Description
Authorization
string
yes
Bearer token containing API key

Path Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Body Parameters

Param
Type
Required
Description
TODO
string
yes
Bearer token containing API key

Example Response

{
"0dce7d85-8d61-41db-86bd-af005df755f4":{
"latency_ms":0,
"status":"error",
"message":"Failed to connect",
"last_checked_at":1624548189
}
}
Last modified 1yr ago
Copy link
On this page
GET /v1/replay
GET /v1/replayer/history/{id}
PUT /v1/replay/{id}/toggle-pause
DELETE /v1/replay
GET /v1/replay/{id}
PUT /v1/replay
DELETE /v1/replay/{id}
POST /v1/replay
PUT /v1/replay/{id}/redo