Insights

Get Insights metrics series for the project

Returns the aggregated insights metrics for this project for the chosen granularity and time period

get/{spaceId}/projects/{projectId}/insights/metrics

Request

  • Base URL
    https://demo.octopus.app/api
  • URL
    https://demo.octopus.app/api/{spaceId}/projects/{projectId}/insights/metrics
  • 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

spaceIdstring required

The ID of the space containing the resource(s).

projectIdstring required

ID of the Project

Query parameters

channelIdstring required

ID of the Channel

environmentIdstring required

ID of the Environment

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

The data grouping granularity, defaults to weekly if not supplied

tenantFilter'UntenantedAndAllTenants' | 'Untenanted' | 'SingleTenant'

How to filter for tenants, defaults to untenanted and all tenants (combined) if not supplied

tenantIdstring

ID of the Tenant

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

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

timeZonestring

The IANA timezone to use when grouping data, defaults to UTC if not supplied

Response

Success

Changes

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