Skip to main content
GET
Query conversation logs

Authorizations

token
string
query
required

Vida API Token

Query Parameters

start
integer

Start time as Unix seconds. Defaults to Unix epoch (Jan 1 1970 00:00:00 UTC).

end
integer

End time as Unix seconds. Defaults to current time.

fields
string

Comma separated list of fields to include. Restricted fields are always removed.

format
enum<string>
default:json

Response format. json returns a JSON envelope. csv streams a CSV file.

Available options:
json,
csv
pageSize
integer

Page size for pagination. Max 10000. Defaults to 20.

Required range: 1 <= x <= 10000
page
integer

Page number starting at 1. Defaults to 1.

Required range: x >= 1
includeFields
boolean

When truthy, include an inferred schema array in the JSON response.

targetAccountId
integer

Selected account whose conversation logs should be returned. Include this when the API token can access more than one account.

outcome
string

Match fields against one task-goal evaluation in the log outcomes array. Supply a URL-encoded JSON object followed by ||json.

field__suffix
string

Replace field with a log field name and suffix with a supported comparison. Values may use an explicit ||json, ||bool, ||number, ||null, or ||string type hint. Repeat this pattern for each filter.

Response

Successful JSON response. When format=csv, a CSV file is streamed with status 200.

success
boolean
Example:

true

message
string
Example:

"Success"

logs
object[]

Array of log entries with restricted fields removed based on caller scope.

count
integer
Example:

20

totalCount
integer
Example:

5231

pagination
object
schema
string[]

Returned only when includeFields is truthy. The inferred list of available fields.

Example: