Get Metadata

get

https://api.beauthenticx.com/Metadata

Gets a list of Metadata objects

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Common next steps after a GET /Metadata/ call:

Use Id with PATCH /Metadata/{id}/ to update metadata fields on a conversation.
Use Id with GET /Conversations/Transcriptions/{conversationId}/ to fetch the transcript.
Use Id with GET /Conversations/Insights/ to retrieve classifier results for the conversation.
Page through results by passing the last Id from the current response as LastId on the next call.

Query Params

StartDate

string

required

Filters based On ArrivedOn date of the metadata File.
ISO-8601 Examples:
UTC datetime: 2022-03-18T21:52:26
UTC datetime with milliseconds: 2022-03-18T21:52:26.8816090Z
UTC date only: 2022-03-19
datetime with timezone: 2022-03-18T17:56:09.8683110-04:00

EndDate

string

required

Filters based On ArrivedOn date of the metadata File. Must be equal to or later than StartDate.
Records with ArrivedOn equal to EndDate will be included in the results.
ISO-8601 Examples:
UTC datetime: 2022-03-18T21:52:26
UTC datetime with milliseconds: 2022-03-18T21:52:26.8816090Z
datetime with timezone: 2022-03-18T17:56:09.8683110-04:00

MediaType

string

Valid Options:

Audio,
Email,
Chat,
Video,
Live,
Metadata,
ProcessedChat
MetadataExtended

ClientCallId

string

Comma-separated list of your system's call identifiers. Up to 100 supported per request.

LastId

string

GUID of the last result from the previous page. Used for cursor-based pagination.

PageSize

int32

Maximum number of metadata objects returned per call.

HierarchyIds

string

Comma-delimited list of hierarchy IDs (GUIDs) to filter by organizational structure. Cannot be used with Chat, Metadata, or MetadataExtended media types as those files are not assigned to a hierarchy.

IncludeAgentCode

boolean

Defaults to false

Boolean flag to include the agent's internal code in the response. Defaults to false.

Response

200Returns the list of all metadata that meet the provided criteria.