Skip to content

Get all data sources in the account

Request

GET /v3/data-sources

this endpoint is get all the data sources in the account with their labels

Security
API_Key
Query
pageinteger, >= 0

Number of results page of an endpoint with paginated results

Default:0
pageSizeinteger, [ 100 .. 1000 ]
Default:100
sortBystring
Default:"lastRun"
Enum:"itemName""itemType""lastRun"
sortDescboolean

Controls sorting order

Default:false
itemNamestring

filter the items by a given name

labelIdsArray of integers

filter the items by label ids

itemTypestring

filter the items by a given item type

Enum:"audit""web-journey"
withRunsboolean

if true - response will only include data sources that have at least one run, if false - only data sources that have no runs. All data sources if not set.

withLabelsboolean

if true - response will include labels for each data source, if false - only the data source id. All data sources if not set. Disabling labels will improve performance.

Default:true
withConsentCategoriesboolean

if true - response will include consent categories. Disabling this will improve performance.

Default:true
GET
/v3/data-sources
curl -i -X GET \
  'https://api.observepoint.com/v3/data-sources?page=0&pageSize=100&sortBy=itemName&sortDesc=false&itemName=string&labelIds=0&itemType=audit&withRuns=true&withLabels=true&withConsentCategories=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Retrieve user events in the account

Bodyapplication/json
metadataobjectrequired

Common metadata for iterable

dataSourcesArray of objectsrequired
Response
{
  "metadata": {
    "pagination": { … }
  },
  "dataSources": [
    { … }
  ]
}