Skip to main content

Report Info API

Overview

The Report Info API returns lightweight report metadata without running a full validation or opening a chat session. It is suited for header cards, context panels, and report selectors.

Source-backed direct runtime path:

  • GET /sdac/report/{reportId}

Widget-safe proxy paths:

  • GET /api/ingestion/sdac/report/{reportId}
  • GET /api/ingestion/sdac/reports/{reportId}

Authentication and Access

Direct APIM callers must send:

  • Authorization: Bearer {access_token}
  • Ocp-Apim-Subscription-Key: {subscription_key}

Widget callers should use the same-origin /api/ingestion/sdac/report/{reportId} proxy instead of calling the runtime route directly from the browser. See Authentication for the gateway flow.

Endpoint

AttributeValue
EndpointGET /api/ingestion/sdac/report/{reportId}
MethodGET
ResponseJSON

Request

Path Parameters

ParameterTypeRequiredDescription
reportIdUUID stringYesReport identifier to load for header metadata and totals

Response

{
"reportId": "8201EDC2-2EDE-4CA1-AF44-D0F5AA185CDB",
"districtName": "Maplewood Richmond Heights",
"quarter": "Q3",
"positions": 21,
"totalSalary": 438221.17,
"totalFringe": 126440.52
}
FieldTypeDescription
reportIdUUID stringReport identifier that was requested
districtNamestringDistrict display name
quarterstringReporting quarter
positionsnumberCanonical position count used for the report summary
totalSalarynumberTotal claimable salary amount
totalFringenumberTotal claimable fringe amount

Error Cases

StatusDescription
400Invalid reportId format
401Missing or expired bearer token
403Invalid subscription key or insufficient scope
404Report not found
500Failed to load report info

Example

curl -X GET "$WIDGET_BASE_URL/api/ingestion/sdac/report/8201EDC2-2EDE-4CA1-AF44-D0F5AA185CDB"

Operational Notes

  • Use this endpoint when your UI only needs summary metadata and totals.
  • Pair it with the Validation API for baseline issues or the Chat API for targeted analysis.