Metrics

Quartz API provides a consistent way to access all calculated metrics.

Retrieving Pipeline Metrics

Retrieves all open opportunities belonging to pipeline , or a subset of open opportunities based on sub-pipeline segmentation.

GET /pipelines/metrics
snapshot request
{
    "pipeline_id" :" ",
    "metric_id" :"metric api_name"
}
time series request
{
    "pipeline_id" :" ",
    "metric_id" :"metric api_name"
    "scope" : 100 // returns the 100 latest daily values
}
date based request
{
    "pipeline_id" :" ",
    "metric_id" :"metric api_name"
    "date" : "day-month-year" // returns value for specified date
}

Retrieving Opportunity Metrics

Retrieves all open opportunities belonging to pipeline , or a subset of open opportunities based on sub-pipeline segmentation.

GET /opportunities/metrics
snapshot request
{
    "opportunity_id" :" ",
    "metric_id" :"metric api_name"
}
time series request
{
    "opportunity_id" :" ",
    "metric_id" :"metric api_name"
    "scope" : 31 // returns the latest 31 values
}
date based request
{
    "opportunity_id" :" ",
    "metric_id" :"metric api_name"
    "date" : "day-month-year" // returns value for specified date
}

Retrieving Member Metrics

Retrieves all open opportunities belonging to pipeline , or a subset of open opportunities based on sub-pipeline segmentation.

GET /teams/members/metrics
{
    "member_id" :" ",
    "metric_id" :"metric api_name"
}
time series request
{
    "member_id" :" ",
    "metric_id" :"metric api_name"
    "scope" : 10 // returns the 10 latest values
}
date based request
{
    "member_id" :" ",
    "metric_id" :"metric api_name"
    "date" : "day-month-year" // returns value for specified date
}

Last updated

Was this helpful?