Skip to main content

Creating an Export Request​


To initiate an export request, you'll need to include the following required parameters in the request body:

  • startDate: The beginning date of the data you want to export in ISO8601 format.
  • endDate: The end date of the data range in ISO8601 format.
  • exportType: One of the following: "ENROLLMENTS", "LEARNING_ACTIVITIES", "NETWORKS", or "USERS".
  • format: Either "CSV" or "JSONL".

These fields are mandatory. You can find more details in the schema view below or in the full documentation under API reference.

Request Body Example and Schema

      {
        "startDate": "2012-09-05T11:12:47.000Z",
        "endDate": "2015-05-28T17:39:23.000Z",
        "exportType": "ENROLLMENTS",
        "format": "CSV"
      }

Response​

Upon successful submission, the response will include a jobId (a Base64-encoded string), which you can use to get the status of your export data job.

Response Example

      {
        "job": {
            "id": "WyJkYXRhLWV4cG9ydHx0ZW5hbnRLZXk6ZHJlYW1idWlsZGVyfHR5cGU6bGVhcm5pbmdfYWN0aXZpdGllc3xmb3JtYXQ6anNvbmx8c3RhcnQ6MjAxMi0wOS0wNVQxMToxMjo0Ny4wMDBafGVuZDoyMDE1LTA1LTI4VDE3OjM5OjIzLjAwMFoiLCJiYjNiNzIyOS0xYTJhLTQzYzgtYmM4Mi01MTc4MjIzMGI4NDYiXQ=="
        }
      }

This guide demonstrates how to create an export data job and retrieve the export data job identifier for getting its status in the separate GET /exports api. For more advanced usage, refer to the complete API documentation in the sidebar.