GET
/
v3
/
bots
/
{botId}
/
results
/
purge
/
{purgeId}
Get Results Purge Status
curl --request GET \
  --url http://127.0.0.1:3333/v3/bots/{botId}/results/purge/{purgeId} \
  --header 'Authorization: Bearer <token>'
{
  "id": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "completedAt": "2023-11-07T05:31:56Z",
  "status": "queued",
  "workspaceId": "<string>",
  "botId": "<string>",
  "userId": "<string>",
  "acknowledged": true,
  "deletedResults": 123,
  "deletedAnswers": 123,
  "userEmail": "<string>",
  "reason": "<string>",
  "confirmationText": "<string>",
  "error": "<string>"
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

botId
string
required
purgeId
string
required

Response

200 - application/json

Default Response

id
string
required
createdAt
string<date-time>
required
completedAt
string<date-time> | null
required
status
enum<string>
required
Available options:
queued,
processing,
done,
error
workspaceId
string
required
botId
string
required
userId
string
required
acknowledged
boolean
required
deletedResults
number
required
deletedAnswers
number
required
userEmail
string | null
reason
string | null
confirmationText
string | null
error
string | null