Extract data from a dataset in CSV

Prev Next

API Endpoint Description

This endpoint retrieves related data for a specific dataset identified by its unique dataset ID. It allows users to access data associated with the dataset and supports response formatting in CSV.

Request

  • Method: GET

  • URL: https://{{base_url}}/zde/api/v2/datasets/{dataset_id}/related/{related_id}/extract

Query Parameters

  • start_date (string): A range filter for the period date of the data. The format is $gte:YYYY-MM-DDTHH:mm:ss.sssZ~$lte:YYYY-MM-DDTHH:mm:ss.sssZ.

  • sort (string): Specifies the sorting order of the results. For example, start_date:desc sorts by start date in descending order.

  • separator (string): Defines the character used to separate values in the CSV response. The default is ;.

  • withHeaders (boolean): Indicates whether to include headers in the CSV response. Set to true to include headers.

  • headers (string): A comma-separated list of fields to include as headers in the CSV response. For example: storage_ranking_max,name,start_date_max,start_date,dataset_id,rule_id,granularity,storage_allocation_avg.

Response

  • Status Code: 200 OK

  • Content-Type: text/csv

  • Response Structure: The response will be in CSV format, with the first row containing the specified headers, and subsequent rows containing the corresponding data values.

This endpoint is useful for obtaining detailed insights into the related data of a specified dataset, facilitating data analysis and reporting in a structured CSV format.