Skip to main content
POST
/
reports
Create
curl --request POST \
  --url https://api.mapademics.com/v1/reports \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "name": "Q1 Skills Gap Analysis",
  "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
  }
}'
{
  "report": {
    "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"
  },
  "data": [
    {}
  ],
  "lookupData": {
    "courseProfiles": [
      {
        "courseId": "<string>",
        "courseName": "<string>",
        "courseCode": "<string>",
        "courseDefaultSectionId": "<string>",
        "courseDisplayName": "<string>"
      }
    ],
    "sectionProfiles": [
      {
        "courseId": "<string>",
        "courseName": "<string>",
        "courseCode": "<string>",
        "courseDefaultSectionId": "<string>",
        "courseDisplayName": "<string>",
        "sectionId": "<string>",
        "sectionName": "<string>",
        "sectionInstructorName": "<string>",
        "sectionSkills": [
          {
            "skillId": "<string>",
            "skillName": "<string>",
            "level": 3,
            "confidence": 0.5
          }
        ]
      }
    ],
    "jobProfiles": [
      {
        "jobId": "<string>",
        "jobLibrary": "soc",
        "jobName": "<string>",
        "skillRequirements": [
          {
            "skillId": "<string>",
            "skillName": "<string>",
            "level": 3,
            "confidence": 0.5
          }
        ]
      }
    ],
    "skillProfiles": [
      {
        "skillId": "<string>",
        "skillLibrary": "internal",
        "skillName": "<string>"
      }
    ]
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
name
string
required

Report name

Example:

"Q1 Skills Gap Analysis"

settings
object
required
description
string | null

Report description

Response

Report created and generated successfully

report
object
required
data
object[]
required

Generated report data (type varies by reportType)

lookupData
object
required