curl --request POST \ --url https://realtime-api.voiceflow.com/v1/stable/transcript/grep \ --header 'Authorization: Bearer <token>' --header 'Content-Type: application/json' \ --data '{ "pattern": "<string>", "transcriptIDs": [ "<string>" ], "startDate": "<string>", "endDate": "<string>", "environmentAlias": "<string>", "limit": 25 }'

{ "pattern": "<string>", "scanned": 0, "matched": 0, "capped": true, "errored": 0, "skipped": 0, "note": "<string>", "literalText": true, "hits": [ { "transcriptID": "<string>", "matches": 0, "snippets": [ "<string>" ] } ] }

Authorizations

Authorization

string

header

required

Voiceflow bearer token

Query Parameters

projectID

string

required

The ID of the project to operate on.

Body

pattern

string

required

Regex (case-insensitive) or plain text to find in the dialogue. A pattern may hold one open quantifier (*, +, ?, {n,} or {n,m}), no backreference and no alternation inside a group. Use exact counts such as \d{3}, or put the alternation at the top level: refund|return. Any other pattern runs as plain text, and the result says so.

transcriptIDs

string[]

Transcripts to scan. Leave it out to scan the newest transcripts in the date range.

startDate

object

Lower bound when no transcriptIDs are given: a day or a timestamp.

Show child attributes

Option 1

string

Option 2

string

endDate

object

Upper bound when no transcriptIDs are given: a day or a timestamp.

Show child attributes

Option 1

string

Option 2

string

environmentAlias

string

Only transcripts from this environment, when no transcriptIDs are given.

limit

integer

default:25

How many transcripts to scan at most, 1 to 60.

Response

200 - application/json

pattern

string

required

scanned

integer

required

Transcripts scanned.

matched

integer

required

Transcripts with at least one match.

capped

boolean

More transcripts were in the range, or more unique transcriptIDs were given, than were scanned; note says what to do.

errored

integer

Transcripts whose log could not be read.

skipped

integer

Given transcriptIDs that do not belong to this project.

note

string

literalText

enum<boolean>

The pattern ran as plain text; note says why.

Available options: true

hits

object[]

required

Show child attributes

transcriptID

string

required

matches

integer

required

How many dialogue lines matched.

snippets

string[]

required

Up to 5 matching lines, each cut to 240 characters.

Grep transcripts

Authorizations

Query Parameters

Body

Response

TEXT