WIwithmedley
Exports

Create a new export request

Queue a data export for async processing. User will receive email when ready.

post/api/exports

Request

  • Base URL
    https://api.production.yourmedley.com
  • Auth
    HTTP bearer

Request body

entity_type'participants' | 'coaches' | 'partners' | 'cohorts' | 'groups' | 'sessions' | 'resources' | 'users' | 'survey_responses' | 'attendance' required

Type of data to export

context_type'global' | 'cohort' | 'partner'

Scope of the export

context_idstring uuid

ID of cohort or partner if scoped

filter_contextobject

Current filter/search state to apply to export

selected_columnsstring[]

Column keys to include in export

include_all_columnsboolean

If true, include all available columns

match_current_viewboolean

If true, match currently visible table columns

format'csv' | 'xlsx'
populate_dnm_groupingsboolean

If true, calculate and populate DNM groupings in the export

Response

Export request created and queued

successboolean
messagestring

Changes

No recorded changes to this operation across all 1 revision of this API.