get https://api.talkdeskapp.com/prompts-usage
Scope
prompts:read
Body Response - Schema
200 (prompt usage)
| Parameter | Type | Description | Required |
|---|---|---|---|
| _embedded | object | "_embedded" subdivides into: 1 - "prompt_usages" (array[object]). Required. 1.1 - "id" (string) - the ID of the prompt. Required. 1.2 - "usage" (integer) - usage of the prompt. Required. | yes |
| _links | object | HAL API-related links. "_links" subdivides into: 1 - "self" (object). Required. 1.1 - "href" (string ) >= 1 characters. Required. | yes |
400 (Invalid parameter), 401 (unauthorized access - invalid or unverifiable JWT), 403 (forbidden)
| Parameter | Type | Description | Required |
|---|---|---|---|
| code | string | n/a | yes |
| message | string | n/a | yes |
| description | string | n/a | no |
| fields | array[object] | "fields" subdivides into: "name" (string) "description" (string) | yes (name and description) |
Troubleshooting
If you have any questions regarding the usage of this API, or if you’re having any technical issues, please open a ticket using this form.