Skip to main content
POST
/
reports
/
generate
Generate
curl --request POST \
  --url https://api.mapademics.com/v1/reports/generate \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '{
  "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
}'
{
  "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>"
      }
    ]
  },
  "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
  }
}

Authorizations

X-API-Key
string
header
required

API key for authentication

Body

application/json
reportType
enum<string>
required

Type of report to generate

Available options:
occupationCrosswalk,
jobSkillContribution,
sectionComparison,
skillComparison
courses
string[]

Selected course IDs (required for jobSkillContribution, sectionComparison, skillComparison)

jobs
object[]

Selected job identifiers (required for occupationCrosswalk, jobSkillContribution)

skills
object[]

Selected skill identifiers (required for skillComparison)

grouping
enum<string> | null

Grouping entity (required for sectionComparison)

Available options:
courses,
instructors
view
string | null

Report view type (varies by report type)

area
object | null

Labor market area (required for occupationCrosswalk)

version
integer | null

Report settings version for backward compatibility

Response

Report generated successfully

data
object[]
required

Generated report data (type varies by reportType)

lookupData
object
required
settings
object
required