DAdatadog
Experiments

List metrics

List metrics. Returns a paginated list of the experiment metrics defined for the organization.

get/api/v2/experiments/metrics

Request

Query parameters

includestring[]

Optional fields to include. Repeat this parameter to request several fields. counts adds experiment_count on each metric, which costs an extra aggregate query.

page[limit]integer

Maximum number of results to return. Defaults to 25 when omitted, and is capped at 50 (larger values are clamped to 50). The response includes meta.page (with total) and pagination links.

Maximum number of results to return. Defaults to 25 when omitted, and is capped at 50 (larger values are clamped to 50). The response includes meta.page (with total) and pagination links.

page[offset]integer

Number of results to skip for pagination. Defaults to 0 when omitted.

searchstring

Find metrics whose names contain the search text, regardless of case.

sortstring

Sort field: name, created_at, or updated_at. Prefix with - for descending (for example, -created_at). A single field only; a comma-separated list is rejected. Defaults to created_at descending.

Sort field: name, created_at, or updated_at. Prefix with - for descending (for example, -created_at). A single field only; a comma-separated list is rejected. Defaults to created_at descending.

Response

OK

Example response

{
  "data": [
    {
      "attributes": {
        "created_at": "2024-01-01T12:00:00Z",
        "data_source_type": "CUSTOMER_WAREHOUSE",
        "description": "Share of sessions that reach the order confirmation page",
        "desired_change": "METRIC_INCREASES",
        "format_as_percent": true,
        "metric_type": "SIMPLE",
        "name": "Checkout conversion",
        "numerator_aggregation": {
          "operation": "sum",
          "pipeline_column_suffix": "agg001",
          "timeframe_start_value": 0,
          "warehouse_metric_measure": {
            "id": "550e8400-e29b-41d4-a716-446655440021",
            "pipeline_column_suffix": "rev001"
          }
        },
        "reference_url": "",
        "updated_at": "2024-01-01T12:00:00Z"
      },
      "id": "550e8400-e29b-41d4-a716-446655440002",
      "type": "metrics"
    }
  ]
}

Changes

Changes to this operation have not been checked yet.