Skip to main content
TroopyDocs
Open Troopy
Troopy

API reference / Sessions

Make a bug ticket of a problem

Makes an engineering ticket, kind bug and label sessions, that the Engineer analyzes and plans. The Engineer reads the problem, the events of its sessions and the links to their replays on its card. A person always approves its plan, and Troopy never releases it by itself, because what visitors did steers it. A problem has one open ticket: while it is open, a second call gives it back.

post/api/v1/session-issues/{number}/ticket

Authorization

HeaderAuthorization: Bearer <API key>
Or the headerX-API-Key: <API key>
API keyMake one in Troopy under Settings > API keys. It acts as you, in its workspace.

Other ways to call it

CLItroopy sessions ticket
MCP tooltroopy_file_session_ticket
Rate limit20 calls in 60 seconds, for each key
RetriesSend an Idempotency-Key header. A retry with the same key gets the first answer back, and the operation runs one time.

Path parameters

number*integer

At least 1

Response

201 · application/json
data*object
12 properties
number*integer

Problem 14 is 14

title*string
severity*enum<string>

criticalhighmediumlow

evidence*string

What the events of the sessions show

area*string

The page, the route or the part of the product

status*enum<string>

fixed: its ticket is done, and no session showed it after that

openignoredfixed

seen*integer

How many sessions showed it

firstSeenAt*string

ISO 8601 date and time

lastSeenAt*string

ISO 8601 date and time

sessions*array<object>

The sessions that showed it, newest first, 20 at most

6 properties
id*string
source*enum<string>

Where the session came from: troopy, Troopy's own script, or posthog

troopyposthog

replayUrl*string | null

The replay in Sessions or in PostHog. Null: no replay of the session

replay*string | null

Source troopy: the id of the replay, for GET /session-replays

country*string | null
at*string

ISO 8601 date and time

alert*object | null

Why it needs a look: new, or came_back after its ticket was done

3 properties
why*enum<string>

newcame_back

at*string

ISO 8601 date and time

seen*boolean
ticket*object | null

Its latest bug ticket

3 properties
key*string
title*string
status*enum<string>

backlogtodoin_progressneeds_youin_reviewdonecanceled

Errors

400 invalid_inputFix the field named in detail. Each operation's schema is in /api/v1/openapi.json.
401 unauthorizedSend an API key as `Authorization: Bearer tr_live_...`. Create one in Troopy under Settings.
403 forbiddenThe key lacks a scope this operation needs, or its owner lacks the role. detail says which; create a key with the scope, or ask an organization owner or admin.
404 not_foundCheck the path and any id in it. Every operation is listed in /api/v1/openapi.json.
409 conflictThis Idempotency-Key was used for a different request, or that request is still running. Use a new key for a new request.
429 rate_limitedWait the number of seconds in Retry-After, then retry.