Get datasets

API Endpoint: Get Datasets

This endpoint retrieves a list of datasets available in the system. It is a simple HTTP GET request that returns a collection of dataset objects in JSON format.

Request

• Method: GET

• URL: https://{{base_url}}/zsa/api/v2/datasets

Response

Upon a successful request, the API will return a 200 OK status along with a JSON array containing dataset objects. Each dataset object includes the following fields:

• tags: An array of tags associated with the dataset.

• id: A unique identifier for the dataset.

• name: The name of the dataset.

• dateFieldName: The name of the date field, if applicable.

• timeZone: The timezone associated with the dataset.

• state: The current state of the dataset.

• relatedDatasetRuleState: The state of any related dataset rules.

• apiName: The API name associated with the dataset.

• strategy: An object containing strategy details, including:

  • tags: Tags associated with the strategy.

  • id: Unique identifier for the strategy.

  • label: A label for the strategy.

  • rules: An array of rules associated with the strategy.

  • creation: Information about the creation of the strategy.

  • edition: Details about the strategy edition.

  • lastExecutionDate: The last execution date of the strategy.

  • datasets: Related datasets.

• indexedFieldNames: An array of indexed field names.

• aggregations: An object containing aggregation details.

• operations: An object containing operation details.

• aggregatedIndexes: An array of aggregated indexes.

• creation: Information about the creation of the dataset.

• edition: Details about the dataset edition.

• originType: The origin type of the dataset.

• associatedDate: Date associated with the dataset.

• associatedBy: User associated with the dataset.

• allocationSize: The size allocated for the dataset.

• category: The category of the dataset.

• logLevel: The log level for the dataset.

• collectionMethod: The method used for data collection.

• description: A description of the dataset.

• metadata: Metadata associated with the dataset, including smfNumber.

Notes

• Ensure to handle cases where fields may be null or empty in the response.

• This endpoint does not require any parameters to be passed in the request.