What is metadata

Metadata provides additional information about API responses and requests that is not part of the core metric values.
It is used to give context, control behaviour, and expose operational details without affecting the underlying data.

Metadata in requests

Some endpoints support a Meta parameter in the query string.

Meta can be used to:

• Pass auxiliary request information

• Control advanced filtering or internal flags (when supported)

• Attach contextual data for debugging or analytics

The exact behaviour of Meta depends on the endpoint.
If an endpoint does not explicitly document metadata support, the parameter is ignored.

Metadata in responses

Certain endpoints may include a meta object in the response payload.

This can contain:

• Informational key-value pairs

• Execution or query context

• Additional response details not suitable for top-level fields

Metadata fields are optional and may be null.

Error metadata

When a request fails or partially fails, metadata may appear inside the error structure to provide:

• Field-level error context

• Internal error codes

• Supplemental diagnostic information

This is especially relevant for bulk and query endpoints.

Important notes

• Metadata is non-breaking and may evolve over time.

• Clients should not hard-depend on undocumented metadata keys.

• Metric values should always be read from the primary response fields, not metadata.