Skip to content

Data Exports

This object allows you to export specific data sets from Kantata OX. You can create or cancel exports. You can also view the full schema of available data sets, view details for all exports, and download exports.

To use these endpoints, you need to be an account administrator.

Operations

Get a list of Data Exports

Request

Returns information on all exports that have been requested, including their status and the data sets and columns that were selected for the exports.

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.
onlystring

Allows you to request one or more resources directly by ID. Multiple IDs can be supplied in a comma separated list, like GET /api/v1/workspaces.json?only=5,6,7.

pageinteger, (int32)
Default:1
per_pageinteger, (int32), <= 200
Default:20
GET
/exports
curl -i -X GET \
  'https://api.mavenlink.com/api/v1/exports?include=string&only=string&page=1&per_page=20'

Responses

A list of Data Exports have been retrieved.

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"
      ]
    }
  }
}