API Reference
API Reference

Get Insights Folder Details

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

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

Responses

200Successful Response

application/json

response FolderDetails required
8 fields
namestringrequired

Human-readable name of insight folder

labelstring | nulloptional

optional label assigned to insight folder

descriptionstring | nulloptional

Text description of insight upload folder

idintegerrequired

System-assign folder ID

created_atstring (date-time)optional

Timestamp at which insight upload folder was created

updated_atstring (date-time)optional

Timestamp at which insight upload folder was last updated

last_updated_bystringrequired

Email of user who last updated upload folder

folder_statsobjectrequired

Meta-data of insight upload files associated with the folder

1 field
{key}string | integer | numberoptional
3 options
Option 1stringoptional
Option 2integeroptional
Option 3numberoptional
Response example
{
  "name": "string",
  "label": "string",
  "description": "string",
  "id": 0,
  "created_at": "string",
  "updated_at": "string",
  "last_updated_by": "string",
  "folder_stats": "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"
    }
  ]
}