Get export center exports

v3 API/

Request

GET /v3/exports

Security

API_Key

Query

pageinteger, >= 0

Page number, starts with 0

Default:0

sizeinteger, [ 20 .. 200 ]

Default:20

sortBystring

Controls sorting

Default:"date_exported"

Enum:"date_exported""item_name""run_date""export_name""exported_item_type""requested_by""status""is_scheduled"

sortDescboolean

Controls sorting order

Default:false

exportedItemTypestring

aggregate filter for different export types and item types

Enum:"audit""web_journey""live_connect""consent_categories""alert""account_usage""grid_data"

searchstring

Filter by item or export name in "contains" mode

Example:search=my audit

requestedByUserIdinteger

Filter by user ID of export requestor

Example:requestedByUserId=123

exportIdsArray of integers, non-empty

Filter by a list of one or more export IDs, comma separated (example exportIds=1,2 or exportIds=1)

GET

/v3/exports

curl -i -X GET \
  'https://api.observepoint.com/v3/exports?page=0&size=20&sortBy=date_exported&sortDesc=false&exportedItemType=audit&search=my%20audit&requestedByUserId=123&exportIds=0' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Export Center exports

Bodyapplication/json

metadataobjectrequired

Common metadata for iterable

exportsArray of objectsrequired

Response

{
  "metadata": {
    "pagination": { … }
  },
  "exports": [
    { … }
  ]
}