Pearl

Get Calls Bulk

Retrieves calls within a date range like Get Calls, but lets the caller opt into additional fields (transcript, collected info, summary, recording, sentiment, credits, ...) via the Fields property. Only the requested fields are returned.

post/v2/Pearl/{pearlId}/Calls/Bulk

Request

Base URL
https://api.nlpearl.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v2/Pearl/:pearlId/Calls/Bulk/post.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

pearlIdstring required

Request body

skipinteger

Number of entries to skip for pagination.

limitinteger

Limit on the number of entries to return.

sortPropstring nullable

Property name to sort by.

isAscendingboolean

Whether the sort order is ascending.

fromDatestring date-time required

The start date for filtering the search results.

toDatestring date-time required

The end date for filtering the search results.

tagsstring[] nullable

List of tags to filter by.

statusesEConversationStatusView[] nullable

List of Status to filter by.

searchInputstring nullable

Text to filter by.

fieldsstring[] nullable

Optional list selecting which additional fields are included in each returned call. Only the requested fields are populated; all others are omitted. Allowed values: Tags, Name, Summary, Recording, Transcript, CollectedInfo, OverallSentiment, IsCallTransferred, QueueDuration, CreditDebited, SmsCreditDebited, LeadId.

Response

Calls within the specified date range, including the requested fields.

countinteger

The total number of items matching the search criteria.

Changes

No recorded changes to this operation across all 1 revision of this API.