CLcloudglue
Segmentations
Describe

List describe jobs for a segmentation

Changed on

List all describe jobs that referenced the specified segmentation. Returns describe job records associated with the segmentation.

get/segmentations/{segmentation_id}/describes

Request

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

Path parameters

segmentation_idstring uuid required

The ID of the segmentation job

Query parameters

include_databoolean

Include the describe data in the response. If false, only job information is returned. Defaults to false.

response_format'json' | 'markdown'

Output format for the describe data

limitinteger

Number of items to return

offsetinteger

Offset from the start of the list

include_metadataboolean

Include the file's user-defined metadata and source metadata. In markdown these render as a ## Metadata section; in JSON they populate file.metadata and file.source_metadata.

Response

List of describe outputs for the segmentation

object'list' required

Object type, always 'list'

totalinteger required

Total number of describe 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

  • 85130a1f5247Revision changes
    • info

      added the optional property /// to the response with the status