Skip to main content
GET
/
reports
/
{reportId}
Get
curl --request GET \
  --url https://api.mapademics.com/v1/reports/{reportId} \
  --header 'X-API-Key: <api-key>'
{
  "id": "<string>",
  "organizationId": "<string>",
  "name": "<string>",
  "description": "<string>",
  "settings": {
    "reportType": "occupationCrosswalk",
    "courses": [
      "<string>"
    ],
    "jobs": [
      {
        "id": "15-1252",
        "lib": "soc"
      }
    ],
    "skills": [
      {
        "id": "<string>",
        "lib": "internal"
      }
    ],
    "grouping": "courses",
    "view": "<string>",
    "area": {
      "type": "national",
      "code": "<string>"
    },
    "version": 123
  },
  "createdAt": "2023-11-07T05:31:56Z",
  "updatedAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Path Parameters

reportId
string
required

Unique identifier for the report

Response

Report retrieved successfully

id
string
required
organizationId
string
required
name
string
required
settings
object
required
createdAt
string<date-time>
required
updatedAt
string<date-time>
required
description
string | null
deletedAt
string<date-time> | null