API Reference
API Reference

Fetch Insights Upload Files

GET/api/v1/insights/folders/{folder_id}/files

Authentication

Syllable-API-Keyrequired

Send Syllable-API-Key in the header.

Need a credential? Create or manage an API token in the Syllable Console.

Parameters

Path parameters

folder_id integer path required

Query parameters

page integer | null query optional

The page number from which to start (0-based)

Default 0Minimum 0Example 0
limit integer query optional

The maximum number of items to return

Default 25Minimum 0Example 25
search_fields enum<string>[] query optional

String names of fields to search. Correspond by index to search field values

Default []Example name
Item schema
itemsenum<string>required
Allowed values ["filename","filename_exact","call_id","agent_number","customer_number","duration","start_time","end_time","created_at"]
search_field_values string[] query optional

Values of fields to search. Correspond by index to search fields. Unless field name contains "list", an individual search field value cannot be a list

Default []Example Some Object Name
Item schema
itemsstringrequired
order_by enum<string> | null query optional

The field whose value should be used to order the results

Allowed values ["filename","filename_exact","call_id","agent_number","customer_number","duration","start_time","end_time","created_at"]Example name
order_by_direction enum<string> | null query optional

The direction in which to order the results

Allowed values ["asc","desc"]
fields enum<string>[] | null query optional

The fields to include in the response

Default []Example []
Item schema
itemsenum<string>required
Allowed values ["filename","filename_exact","call_id","agent_number","customer_number","duration","start_time","end_time","created_at"]
start_datetime string | null query optional

The start datetime for filtering results

Example 2023-01-01T00:00:00Z
end_datetime string | null query optional

The end datetime for filtering results

Example 2024-01-01T00:00:00Z

Responses

200Successful Response

application/json

response ListResponse_InsightsUploadFile_ required
5 fields
itemsInsightsUploadFile[]required

List of items returned from the query

Item schema
itemsInsightsUploadFilerequired

Response model for an insight upload file.

13 fields
idintegerrequired

System-assigned ID for the upload file

folder_idintegerrequired

System-assigned ID for the folder to which the file belongs

filenamestringrequired

Name of the uploaded file

object_keystringrequired

Object-store key of the uploaded file

call_idstring | nulloptional

Unique identifier for the call associated with the uploaded file

agent_numberstring | nulloptional

Agent number associated with the uploaded file

customer_numberstring | nulloptional

Customer number associated with the uploaded file

durationnumber | nulloptional

Length in seconds of the uploaded recording

start_timestring (date-time) | nulloptional

Start time of the uploaded file

end_timestring (date-time) | nulloptional

End time of the uploaded file

error_messagestring | nulloptional

Error message associated with the uploaded file

metadataobject | nulloptional

Meta-data associated with the uploaded file

1 options
{key}string | integer | numberoptional
3 options
Option 1stringoptional
Option 2integeroptional
Option 3numberoptional
created_atstring (date-time)optional

Timestamp at which insight upload file was created

pageintegerrequired

The page number of the results (0-based)

page_sizeintegerrequired

The number of items returned per page

total_pagesinteger | nulloptional

The total number of pages of results given the indicated page size

total_countinteger | nulloptional

The total number of items returned from the query

Response example
{
  "items": [
    {
      "id": 0,
      "folder_id": 0,
      "filename": "string",
      "object_key": "string",
      "call_id": "string",
      "agent_number": "string",
      "customer_number": "string",
      "duration": "string",
      "start_time": "string",
      "end_time": "string",
      "error_message": "string",
      "metadata": "string",
      "created_at": "string"
    }
  ],
  "page": 0,
  "page_size": 0,
  "total_pages": "string",
  "total_count": "string"
}
422Validation Error

application/json

response HTTPValidationError required
1 field
detailValidationError[]optional
Item schema
itemsValidationErrorrequired
3 fields
locstring | integer[]required
Item schema
itemsstring | integerrequired
2 options
Option 1stringrequired
Option 2integerrequired
msgstringrequired
typestringrequired
Response example
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string"
    }
  ]
}