Search data sources with specific item IDs

Request

POST /v3/data-sources/search

This endpoint retrieves 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

Bodyapplication/json

itemNamestring

filter the items by a given name

labelIdsArray of integers

filter the items by label ids

itemIdsArray of integers

filter the items by IDs (itemName & labelIds are ignored)

itemTypestring

Type of data source item.

Enum:"audit""web-journey"

withRunsboolean

If true - response includes only data sources with at least one run. If false - only those without runs. All if not set.

POST

/v3/data-sources/search

curl -i -X POST \
  'https://api.observepoint.com/v3/data-sources/search?page=0&pageSize=100&sortBy=itemName&sortDesc=false' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "itemName": "string",
    "labelIds": [
      0
    ],
    "itemIds": [
      0
    ],
    "itemType": "audit",
    "withRuns": true
  }'

Responses

Retrieve user events in the account

Bodyapplication/json

metadataobjectrequired

Common metadata for iterable

dataSourcesArray of objectsrequired

Response

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