Extract data from a dataset

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 pagination and response formatting.

Request

  • Method: GET

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

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.- page (integer): Specifies the page number of the results to retrieve. Default is 1.

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

  • size (integer): Determines the number of results per page. Maximum value is 1000.

  • format (string): Specifies the format of the response. Acceptable values are OBJECT, LIST, AVRO.

Response

  • Status Code: 200 OK

  • Content-Type: application/json

  • Response Structure: The response is an array of objects, where each object contains its related fields.

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