Get all queries

API Endpoint: Get Queries

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

Request

• Method: GET

• URL: https://{{base_url}}/zde/api/v2/queries

Response

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

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

• id: A unique identifier for the query.

• label: A label for the query.

• description: A description of the query.

• filters: An array of filters applied to the query.

• globalDataset: An object representing the global dataset, containing:

  • id: Unique identifier for the global dataset.

  • name: The name of the global dataset.

• sourceDataset: An object representing the source dataset, containing:

  • id: Unique identifier for the source dataset.

  • name: The name of the source dataset.

• creation: Information about the creation of the query, including:

  • at: Timestamp of creation.

  • by: User who created the query.

• edition: Details about the query edition, including:

  • at: Timestamp of the last edition.

  • by: User who edited the query.

• relativePeriod: An object containing details about the relative period, including:

  • dateFieldName: The name of the date field.

  • periodUnit: The unit of the period.

  • offset: The offset for the period.

  • length: The length of the period.

  • id: Unique identifier for the relative period.

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.