Get Schedule

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

Retrieves an export schedule by id, with the cadence it runs on, how far through that cadence it is, and the filters and destination each run uses.

GET/v2/export-schedules/{exportScheduleId}

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

200

{
  "success": true,
  "data": {
    "id": "<EXPORT-SCHEDULE-ID>",
    "name": "Weekly checkout conversations",
    "description": "Last week's checkout conversations for the data team.",
    "exportType": "TRACES",
    "filters": {
      "operator": "AND",
      "groups": [
        {
          "operator": "AND",
          "filters": [
            {
              "category": "User Id",
              "condition": "Is less than",
              "value": "string",
              "key": "string"
            }
          ]
        }
      ]
    },
    "destinationId": "<EXPORT-DESTINATION-ID>",
    "scheduleSettings": {
      "recurrence": "ONCE",
      "repeatEvery": 1,
      "repeatUnit": "MINUTE",
      "startAt": "2025-02-01T09:00:00.000Z",
      "endAt": "2025-12-31T23:59:59.000Z",
      "maxRuns": 12,
      "runCount": 6,
      "lastRunAt": "2025-02-24T09:00:00.000Z",
      "enabled": true
    },
    "createdAt": "2025-01-15T10:30:00.000Z",
    "updatedAt": "2025-02-24T09:00:00.000Z"
  },
  "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.

Path parameters

exportScheduleIdstringRequired
The id of the export schedule.

Response

Get Schedule succeeded.

successboolean
Indicates if the request was successful.
dataobject
A recurring export of this project's data. Each run covers the window since the previous run and narrows it by filters, where an empty groups list exports everything in that window.
Show 9 propertiesHide 9 properties
- idstring
  The id of the schedule, generated by Confident AI.
- namestring
  The name of the schedule.
- descriptionstring | null
  What the schedule exports, or null when it has no description.
- 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
- filtersobject
  A set of filter groups combined by a top-level operator. Each group combines its filter rows by its own operator, and each row matches one property, such as Name or User Id, against a value with a condition such as Is or Contains.
  Show 2 propertiesHide 2 properties
  - operatorenum
    Show 2 enum valuesHide 2 enum values
    AND
    OR
  - groupslist of objects
    Show 2 propertiesHide 2 properties
    operatorenum
    Show 2 enum valuesHide 2 enum values
    AND
    OR
    filterslist of objects
    Show 4 propertiesHide 4 properties
    categoryenum
    Show 80 enum valuesHide 80 enum values
    User Id
    Thread Id
    Trace Uuid
    Trace Name
    Trace Version
    Trace Status
    Trace Tags
    Trace
    Span Uuid
    Name
    Span Name
    Span Type
    Span Status
    Metrics Status
    Error Status
    Name
    Model
    Provider
    Integration
    Embedder
    Chunk Size
    Top-K
    Hyperparameter
    Dataset
    Dataset Name
    Test Run ID
    Identifier
    Test File
    Status
    Official
    Evals Mode
    Tests Passed
    Tests Failed
    Pass Rate
    Fail Rate
    Star Rating
    Thumbs Rating
    Explanation
    Expected Output
    Expected Outcome
    Annotator
    End User
    Annotation Type
    Annotation Name
    Criteria
    Annotation Date
    Metric Score
    Metric Status
    Name
    Metadata
    Classifier
    Metric
    Metric Name
    Trace Count
    Test Case ID
    Requested review from
    Assigned to
    Tags
    Labels
    Tools Called
    Finalized
    Golden ID
    Ingestion Task
    Latency
    Environment
    Review flag
    Vulnerability
    Vulnerability Type
    Attack Method
    Risk Category
    Framework
    Assessment ID
    Prompt Alias
    Prompt Version
    Prompt Label
    Prompt Commit Hash
    Prompt
    Annotations
    Status Code
    Actor Type
    conditionenum | enum | enum | enum | enum | enum | enum | enum | enum | enum
    Show 10 variantsHide 10 variants
    enum
    Show 6 enum valuesHide 6 enum values
    Is less than
    Is equal or less than
    Is greater than
    Is equal or greater than
    Is equal to
    Does not equal
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Has
    Has not
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Is
    Is not
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Is one of
    Is not one of
    OR
    enum
    Show 4 enum valuesHide 4 enum values
    Is
    Is not
    Is empty
    Is not empty
    OR
    enum
    Show 2 enum valuesHide 2 enum values
    Contains
    Does not contain
    OR
    enum
    Show 3 enum valuesHide 3 enum values
    Contains
    Contains only
    Does not contain
    OR
    enum
    Show 4 enum valuesHide 4 enum values
    Has decreased by more than
    Has decreased by less than
    Has increased by more than
    Has increased by less than
    OR
    enum
    Show 1 enum valueHide 1 enum value
    Has changed from
    OR
    enum
    Show 1 enum valueHide 1 enum value
    Is between
    valuestring | number | list of strings
    Show 3 variantsHide 3 variants
    string
    OR
    number
    OR
    list of strings
    keystring
- destinationIdstring | null
  The id of the export destination each run delivers its file to, or null when the schedule has none.
- scheduleSettingsobject | null
  The cadence an export schedule runs on, together with how far through that cadence it is.
  Show 9 propertiesHide 9 properties
  - recurrenceenum
    How often a schedule fires: ONCE runs a single time at startAt, INTERVAL repeats every repeatEvery repeatUnits.
    Show 2 enum valuesHide 2 enum values
    ONCE
    INTERVAL
  - repeatEveryinteger | null
    How many repeatUnits apart the runs are, or null for a schedule that does not repeat.
  - repeatUnitenum | null
    The unit repeatEvery counts for an INTERVAL schedule.
    Show 5 enum valuesHide 5 enum values
    MINUTE
    HOUR
    DAY
    WEEK
    MONTH
  - startAtstring | null
    When the schedule first runs, or null when it started immediately.
  - endAtstring | null
    When the schedule stops running, or null when it is open-ended.
  - maxRunsinteger | null
    How many times the schedule runs before it stops, or null when it runs indefinitely.
  - runCountinteger
    How many times the schedule has run so far.
  - lastRunAtstring | null
    When the schedule last ran, or null when it has never run.
  - enabledboolean
    Whether the schedule is currently running.
- createdAtstring
  When the schedule was created.
- updatedAtstring
  When the schedule was last changed.
linkstring
This is the URL of the resource on the Confident AI platform.
deprecatedboolean
Indicates if this endpoint is deprecated.

Built byConfident AI