List Schedules

GEThttps://api.confident-ai.com/v2/export-schedules

Lists the export schedules in your Confident AI project one page at a time, newest first. Narrow the page with exportType or enabled; retrieve one by id to see its cadence, filters and destination.

GET/v2/export-schedules

curl -X GET "https://api.confident-ai.com/v2/export-schedules" \
  -H "CONFIDENT_API_KEY: <PROJECT-API-KEY>"

200

{
  "success": true,
  "data": {
    "exportSchedules": [
      {
        "id": "<EXPORT-SCHEDULE-ID>",
        "name": "Weekly checkout conversations",
        "exportType": "TRACES",
        "enabled": true
      }
    ],
    "totalExportSchedules": 3,
    "page": 1,
    "pageSize": 25
  },
  "link": "https://app.confident-ai.com/project/<PROJECT-ID>/project-settings/exports",
  "deprecated": false
}

Headers

CONFIDENT_API_KEYstringRequired
The API key of your Confident AI project.

Query parameters

exportTypeenum
enabledenum
Return only the schedules that are currently running, or only those that are paused. Omit it for both.
pageintegerdefault: 1
The page to return. Defaults to 1.
pageSizeintegerdefault: 25
The number of results per page, at most 100. Defaults to 25.

Response

List Schedules succeeded.

successboolean
Indicates if the request was successful.
dataobject
One page of export schedules, with the total across all pages.
Show 4 propertiesHide 4 properties
- exportScheduleslist of objects
  The schedules for the current page, newest first.
  Show 4 propertiesHide 4 properties
  - idstring
    The id of the schedule, generated by Confident AI.
  - namestring
    The name of the schedule.
  - exportTypeenum
    What each run of the schedule exports. Only project-scoped export types can be scheduled: TRACES_WITH_SPANS, TRACES, CONVERSATIONS, CONVERSATION_METRICS. Audit log exports are organization-scoped and are not export schedules. Please configure them on the platform instead.
    Show 5 enum valuesHide 5 enum values
    TRACES
    TRACES_WITH_SPANS
    CONVERSATIONS
    CONVERSATION_METRICS
    AUDIT_LOGS
  - enabledboolean
    Whether the schedule is currently running.
- totalExportSchedulesinteger
  The total number of schedules matching the query.
- pageinteger
  The page this response covers.
- pageSizeinteger
  The number of schedules per page.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI