Skip to main content

Sprint Export API

Last updated on

The Sprint Export API exports Sprint Metrics analytics and sprint-level reporting data in CSV format.

Use sprint exports to analyze sprint completion trends, work distribution, throughput, and sprint health metrics across teams and organization trees.

Authentication

All requests require the following headers:

HeaderValue
authorizationApiKey <YOUR_SEI_API_KEY>
Content-Typeapplication/json

You must also include the following query parameters on all requests:

ParameterDescription
projectIdentifierHarness project identifier
orgIdentifierHarness organization identifier

Export workflow

Creates a new asynchronous sprint export job.

# Replace BASE_URL with your Harness cluster URL
POST {BASE_URL}/v2/insights/sprint/exports
Request Body
{
"scope": {
"teamId": "team_abc123", // String identifier; use either teamId OR orgTreeName (not both)
"orgTreeName": "string",
"orgIdentifier": "string", // Required when using orgTreeName
"projectIdentifier": "string"
},
"dateRange": {
"start": "2026-01-01", // Required
"end": "2026-03-31" // Required
},
"options": {
"granularity": "MONTHLY" // Required
},
"metricGroups": ["work", "delivery", "analysis"],
"metric": ["Sprint_Commit", "Total_Work_Delivered", "Churn_Rate"]
}

The following request fields are available:

FieldDescription
scope.teamIdExport data for a specific team.
scope.orgTreeNameExport data for an organization tree.
dateRange.startExport start date (yyyy-MM-dd).
dateRange.endExport end date (yyyy-MM-dd).
options.granularityReporting interval (WEEKLY, MONTHLY, QUARTERLY).
metricGroupsHigh-level business groups, i.e. work, delivery, or analysis.
metricsSprint Metrics such as Sprint_Commit, Total_Work_Delivered, or Churn_Rate.

Available metric groups

The following Sprint metric groups are available:

Metric GroupSprint-level MetricsTeam-level Metrics
workSPRINT_COMMIT, SPRINT_CREEP, SPRINT_SIZE, SCOPE_CREEP_PERCENTSPRINT_COMMIT, SPRINT_CREEP, SPRINT_SIZE, SCOPE_CREEP_PERCENT
deliveryTOTAL_WORK_DELIVERED, DELIVERED_COMMIT, MISSED_COMMIT, DELIVERED_CREEP, MISSED_CREEP, TOTAL_DELIVERED_WORK_VS_COMMITTED_WORKTOTAL_WORK_DELIVERED, SPRINT_VELOCITY, DELIVERED_COMMIT, MISSED_COMMIT, DELIVERED_CREEP, MISSED_CREEP, TOTAL_DELIVERED_WORK_VS_COMMITTED_WORK
deliveryAnalysisCOMMITTED_WORK_DELIVERED_PERCENT, CREEP_WORK_DELIVERED_PERCENT, TOTAL_WORK_DELIVERED_PERCENTCOMMITTED_WORK_DELIVERED_PERCENT, CREEP_WORK_DELIVERED_PERCENT, TOTAL_WORK_DELIVERED_PERCENT
analysisTICKETS_REMOVED_MID_SPRINT, CHURN_RATECHURN_RATE, PREDICTABILITY_DELIVERY_CONSISTENCY, PREDICTABILITY_RELIABILITY_OF_COMMITMENT

The following options are available:

OptionDescription
computationModeExport sprint metrics using STORY_POINTS or TICKETS. This matches the Sprint UI reporting mode.
metricLevelExport metrics grouped by team or sprint.
granularityReporting interval such as SPRINT or MONTHLY.
Example Request
curl -X POST "${BASE_URL}/v2/insights/sprint/exports?projectIdentifier=${PROJECT_ID}&orgIdentifier=${ORG_ID}" \
-H "Content-Type: application/json" \
-H "authorization: ApiKey <YOUR_SEI_API_KEY>" \
-d '{
"scope": {
"teamId": "1"
},
"dateRange": {
"start": "2026-01-01",
"end": "2026-03-31"
},
"metricGroups": [
"work",
"delivery",
"deliveryAnalysis",
"analysis"
],
"options": {
"computationMode": "STORY_POINTS",
"metricLevel": "team",
"granularity": "SPRINT"
}
}'
Example Response
{
"exportId": "exp_7a8b9c0d",
"createdAt": "2025-12-29T10:00:00Z",
"createdBy": {
"userId": "user_123",
"name": "John Doe",
"email": "john.doe@company.com"
},
"metadata": {
"scope": {
"teamId": "1",
"teamName": "Platform Team"
},
"dateRange": {
"start": "2026-01-01",
"end": "2026-03-31"
},
"metricGroups": [
"work",
"delivery",
"deliveryAnalysis",
"analysis"
],
"options": {
"computationMode": "STORY_POINTS",
"metricLevel": "team",
"granularity": "SPRINT",
"format": "csv",
"compression": "gzip"
}
},
"message": "Export created successfully"
}

Downloads are gzip-compressed by default and export responses include team hierarchy information where applicable.