Insights

Get Insights metrics series for the Insights Report

Returns the aggregated insights metrics for this insights report for the chosen granularity and time period grouped by the chosen split

get/spaces/{spaceIdentifier}/insights/reports/{reportId}/metrics/v1

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/spaces/{spaceIdentifier}/insights/reports/{reportId}/metrics/v1
  • Auth
    • API key in header X-Octopus-ApiKey
    • or API key in query parameter ApiKey
    • or API key in header X-NuGet-ApiKey

Path parameters

reportIdstring required

ID of the Insights Report

spaceIdentifierstring required

Identifier (ID or slug) of the space

Query parameters

split'None' | 'Project' | 'ProjectGroup' | 'Environment' | 'EnvironmentGroup' | 'Tenant' | 'TenantTagSet' required

How to split the metrics

timeRange'LastMonth' | 'LastQuarter' | 'LastYear'

The time period to get data for, defaults to last quarter if not supplied

granularity'Monthly' | 'Weekly' | 'Daily'

The data grouping granularity, defaults to weekly if not supplied

tenantTagSetIdstring

If TenantTagSet is chosen for Split, this is required, otherwise it is ignored. It is the tag set to split on.

Response

Success

Changes

No recorded changes to this operation across all 13 revisions of this API.