analytics
Open an operation to see its authentication, its parameters and the fields of its request and response.
2 operations
GET/v1/analytics/details
Modules, approvals, releases over time, origins, categories, proactive fixes and hours saved (plan feature analytics).
/v1/analytics/detailsAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
rangequery | enum | Values 30d | 90d | 180d | 365d |
workspace_idquery | string |
Response 200
| Name | Type | Description |
|---|---|---|
rangerequired | enum | Values 30d | 90d | 180d | 365d |
fromrequired | string (date-time) | |
torequired | string (date-time) | |
workspace_idrequired | string | |
modulesrequired | object | |
modules.itemsrequired | array of object | |
modules.items[].modulerequired | string | |
modules.items[].ticketsrequired | integer | |
modules.tickets_with_symbolsrequired | integer | |
modules.other_ticketsrequired | integer | |
approvalsrequired | object | |
approvals.fixes_approvedrequired | integer | |
approvals.approved_without_changesrequired | integer | |
approvals.raterequired | number | |
approvals.changes_requestedrequired | integer | |
approvals.rejectedrequired | integer | |
releasesrequired | object | |
releases.bucketrequired | enum | Values week | month |
releases.pointsrequired | array of object | |
releases.points[].startrequired | string (date) | |
releases.points[].releasesrequired | integer | |
releases.points[].tickets_releasedrequired | integer | |
by_originrequired | array of object | |
by_origin[].originrequired | enum | Values email | widget | github | proactive |
by_origin[].ticketsrequired | integer | |
by_categoryrequired | array of object | |
by_category[].categoryrequired | enum | Values usage | config | docs | bug | feature_request | unknown |
by_category[].ticketsrequired | integer | |
proactiverequired | object | |
proactive.ticketsrequired | integer | |
proactive.fixes_releasedrequired | integer | |
hours_savedrequired | object | |
hours_saved.hoursrequired | number | |
hours_saved.answersrequired | integer | |
hours_saved.diagnosesrequired | integer | |
hours_saved.fixesrequired | integer | |
hours_saved.reviewsrequired | integer | |
hours_saved.heuristicrequired | object | |
hours_saved.heuristic.answer_minutesrequired | number | |
hours_saved.heuristic.diagnosis_minutesrequired | number | |
hours_saved.heuristic.fix_minutesrequired | number | |
hours_saved.heuristic.review_minutesrequired | number |
GET/v1/analytics/summary
Basic support figures of the period and the weekly north star (every plan).
/v1/analytics/summaryAuthentication: Dashboard session
Parameters
| Name | Type | Description |
|---|---|---|
rangequery | enum | Values 30d | 90d | 180d | 365d |
workspace_idquery | string |
Response 200
| Name | Type | Description |
|---|---|---|
rangerequired | enum | Values 30d | 90d | 180d | 365d |
fromrequired | string (date-time) | |
torequired | string (date-time) | |
workspace_idrequired | string | |
tickets_receivedrequired | integer | |
tickets_resolvedrequired | integer | |
median_first_response_minutesrequired | number | |
median_release_minutesrequired | number | |
releasesrequired | integer | |
north_starrequired | object | |
north_star.weeksrequired | array of object | |
north_star.weeks[].week_startrequired | string (date) | |
north_star.weeks[].ticketsrequired | integer | |
north_star.weekly_averagerequired | number |