Skip to main content

Business Alignment Export API

Last updated on

The Business Alignment Export API exports Business Alignment (BA) metrics in CSV format for teams and organization trees.

Business Alignment exports help measure how engineering effort is distributed across categorized and uncategorized work, including investment areas such as KTLO, New Capability, Quality Improvements, and Security and Compliance.

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 Business Alignment export job.

# Replace BASE_URL with your Harness cluster URL
POST {BASE_URL}/v2/insights/ba/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
},
"metricGroups": ["CATEGORIZED", "UNCATEGORIZED"],
"options": {
"granularity": "MONTHLY" // Required
}
}

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).
metricGroupsOptional filter for CATEGORIZED (mapped to business investment categories) or UNCATEGORIZED work (not mapped to a business category).
options.granularityReporting interval (WEEKLY, MONTHLY, QUARTERLY).
Example Request
curl -X POST "${BASE_URL}/v2/insights/ba/exports?projectIdentifier=${PROJECT_ID}&orgIdentifier=${ORG_ID}" \
-H "Content-Type: application/json" \
-H "authorization: ApiKey <YOUR_SEI_API_KEY>" \
-d '{
"scope": {
"teamId": "team_abc123"
},
"dateRange": {
"start": "2026-01-01",
"end": "2026-03-31"
},
"metricGroups": ["CATEGORIZED", "UNCATEGORIZED"],
"options": {
"granularity": "MONTHLY"
}
}'
Example Response
{
"exportId": "exp_2B3C4D5E",
"status": "QUEUED",
"createdAt": "2025-05-13T10:00:00Z",
"message": "Export job created successfully"
}

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