Skip to content

Generate a Data Export

Request

Generates an export. Use the data set key and each column key that you want to be included in your export. The values need to be properly formatted JSON, which means you may need to escape special characters. If no column keys are provided, the export will fail and return a 422 response.

Example The following example creates a new export containing all the non-custom field columns for the User dataset created during October 2023.

curl -i -X POST 'https://api.mavenlink.com/api/v1/exports' -H 'Content-Type: application/json' -d '{
  "export": {
    "export_definition": {
      "8ebff9db413b3115": {
        "columns": [
          "4eb02f5e2601433d",
          "b02d7f145ad95122",
          "2bfa2c20999efe62",
          "96cb337e5007738b",
          "27e2565ae34ed9eb",
          "d5111608cc214c2a",
          "e59d1cb61256a8cf",
          "77bfd7e48d5ff668",
          "23ca4c0d7b289c5f",
          "7172de0607dcb1ef"
        ],
        "filters": {
          "start_date": "2023-10-01",
          "end_date": "2023-10-31"
        }
      }
    }
  }
}'

This endpoint returns structured Data Export objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the exports top-level JSON key. Please see our Response Format section for more information.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • user (User) - The user who generated the export.
Bodyapplication/jsonrequired
exportobject
{ "export": { "export_definition": { "property1": { "columns": [ "string" ], "filters": { "start_date": "2019-08-24", "end_date": "2019-08-24" } }, "property2": { "columns": [ "string" ], "filters": { "start_date": "2019-08-24", "end_date": "2019-08-24" } } } } }

Responses

Data Export has been created.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
exportsobject
usersobject
Response
{ "count": 0, "meta": { "count": 0, "page_count": 0, "page_number": 0, "page_size": 0 }, "results": [ { "key": "string", "id": "string" } ], "exports": { "property1": { "account_id": 0, "created_at": "2019-08-24T14:15:22Z", "export_definition": { "property1": { "display_name": "string", "key": "string", "columns": [ … ], "filters": { … } }, "property2": { "display_name": "string", "key": "string", "columns": [ … ], "filters": { … } } }, "status": "string", "user_id": "string" }, "property2": { "account_id": 0, "created_at": "2019-08-24T14:15:22Z", "export_definition": { "property1": { "display_name": "string", "key": "string", "columns": [ … ], "filters": { … } }, "property2": { "display_name": "string", "key": "string", "columns": [ … ], "filters": { … } } }, "status": "string", "user_id": "string" } }, "users": { "property1": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] }, "property2": { "abbreviated_timezone": "string", "account_membership_id": "string", "bio": "string", "city": "string", "classification": "string", "country": "string", "custom_field_value_ids": [ "string" ], "email_address": "string", "external_reference_ids": [ "string" ], "full_name": "string", "headline": "string", "last_site_activity": "2019-08-24T14:15:22Z", "manager_id": "string", "photo_path": "string", "role_id": "string", "skill_ids": [ "string" ], "skill_membership_ids": [ "string" ], "state": "string", "website": "string", "work_sample_ids": [ "string" ] } } }