Results
List results
Results
List results
GET
/
v1
/
typebots
/
{typebotId}
/
results
Authorization
string
*
Bearer
Authorization
Required
string
Bearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
typebotId
string
*
typebotId
Required
string
limit
number
limit
number
cursor
string
cursor
string
timeFilter
enum<string>
timeFilter
enum<string>
timeZone
string
timeZone
string
curl --request GET \
--url https://app.typebot.io/api/v1/typebots/{typebotId}/results \
--header 'Authorization: Bearer <token>'
{
"results": [
{
"id": "<string>",
"createdAt": "<string>",
"typebotId": "<string>",
"variables": [
{
"id": "<string>",
"name": "<string>",
"isSessionVariable": true,
"value": "<string>"
}
],
"isCompleted": true,
"hasStarted": true,
"isArchived": true,
"answers": [
{
"createdAt": "<string>",
"resultId": "<string>",
"blockId": "<string>",
"groupId": "<string>",
"variableId": "<string>",
"content": "<string>",
"storageUsed": 123
}
]
}
],
"nextCursor": "<string>"
}
Authorizations
Authorization
string
headerrequiredBearer authentication header of the form Bearer <token>
, where <token>
is your auth token.
Path Parameters
typebotId
string
requiredQuery Parameters
limit
number
default: 50cursor
string
timeFilter
enum<string>
default: last7DaysAvailable options:
today
, last7Days
, last30Days
, monthToDate
, lastMonth
, yearToDate
, allTime
timeZone
string
Response
200 - application/json
results
object[]
requiredresults.id
string
requiredresults.createdAt
string
requiredresults.typebotId
string
requiredresults.variables
object[]
requiredresults.variables.id
string
requiredresults.variables.name
string
requiredresults.variables.isSessionVariable
boolean
results.variables.value
required
results.isCompleted
boolean
requiredresults.hasStarted
boolean | null
requiredresults.isArchived
boolean | null
requiredresults.answers
object[]
requiredresults.answers.createdAt
string
requiredresults.answers.resultId
string
requiredresults.answers.blockId
string
requiredresults.answers.groupId
string
requiredresults.answers.variableId
string | null
requiredresults.answers.content
string
requiredresults.answers.storageUsed
number | null
requirednextCursor
string | null
curl --request GET \
--url https://app.typebot.io/api/v1/typebots/{typebotId}/results \
--header 'Authorization: Bearer <token>'
{
"results": [
{
"id": "<string>",
"createdAt": "<string>",
"typebotId": "<string>",
"variables": [
{
"id": "<string>",
"name": "<string>",
"isSessionVariable": true,
"value": "<string>"
}
],
"isCompleted": true,
"hasStarted": true,
"isArchived": true,
"answers": [
{
"createdAt": "<string>",
"resultId": "<string>",
"blockId": "<string>",
"groupId": "<string>",
"variableId": "<string>",
"content": "<string>",
"storageUsed": 123
}
]
}
],
"nextCursor": "<string>"
}