Skip to content
v3 API/
/
Search for target items (...

Search for target items (audits or web journeys) for custom header assignment

Request

POST /v3/custom-headers/target-items/{itemType}/search
Security
API_Key
Path
itemTypestringrequired

Type of items to search for (AUDIT or WEB_JOURNEY)

Enum:"AUDIT""WEB_JOURNEY"
Query
sortBystring
Default:"ITEM_NAME"
Enum:"IS_ASSIGNED""ITEM_NAME""RUN_DATE"
sortDescboolean

Controls sorting order

Default:false
pageSizeinteger, [ 100 .. 1000 ]
Default:100
pageinteger, >= 0

Number of results page of an endpoint with paginated results

Default:0
Bodyapplication/json
customHeaderGroupIdinteger, (int64)
assignedToCustomHeaderGroupboolean
itemNamestring, non-empty
itemLabelsArray of integers, non-empty

non-empty array of labels present on an item, works as "item has all specified labels" filter

foldersobject

non-empty array of folders with domains (subfolders), items from which will be included in response

POST
/v3/custom-headers/target-items/{itemType}/search
curl -i -X POST \
  'https://api.observepoint.com/v3/custom-headers/target-items/{itemType}/search?sortBy=IS_ASSIGNED&sortDesc=false&pageSize=100&page=0' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "customHeaderGroupId": 0,
    "assignedToCustomHeaderGroup": true,
    "itemName": "string",
    "itemLabels": [
      223
    ],
    "folders": {
      "folders": [
        {
          "folderId": 123,
          "domains": [
            123
          ]
        }
      ]
    }
  }'

Responses

Successful operation

Bodyapplication/json
metadataobject
itemsArray of objects
Response
{
  "metadata": {
    "totalCount": 0,
    "totalPageCount": 0,
    "pageSize": 0,
    "currentPageSize": 0,
    "currentPageNumber": 0
  },
  "items": [
    { … }
  ]
}