CLcloudglue
Segments

List all segmentation jobs

Changed on

List all segmentation jobs with optional filtering

get/segments

Request

  • Base URL
    https://api.cloudglue.dev/v1
  • Auth
    HTTP bearer

Query parameters

limitinteger

Maximum number of segmentation jobs to return

offsetinteger

Number of segmentation jobs to skip

status'pending' | 'processing' | 'completed' | 'failed'

Filter segmentation jobs by status

criteria'shot' | 'narrative'

Filter segmentation jobs by criteria type

created_beforestring date

Filter segmentation jobs created before a specific date (YYYY-MM-DD format), in UTC timezone

created_afterstring date

Filter segmentation jobs created after a specific date (YYYY-MM-DD format), in UTC timezone

urlstring

Filter segmentation jobs by the input URL used for segmentation

Response

A list of segmentation jobs

object'list' required

Object type, always 'list'

totalinteger required

Total number of segmentation jobs matching the query

limitinteger required

Number of items returned in this response

offsetinteger required

Offset from the start of the list

Changes

  • 23d3f240819fRevision changes
    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

  • f90a8032c6aeRevision changes
    • breaking

      the /// response property's min was decreased from 1.00 to 0.60 for the response status

    • breaking

      the /// response's property type changed from integer to number for status

    • breaking

      the /// response's property type changed from integer to number for status