Skip to content
v3 API/
/
Get filterable specific i...

Get filterable specific item type usage summary for account. If web journeys are not included in contract, 404 status code will be returned

Request

POST /v3/usage/{itemType}/summary
Security
API_Key
Path
itemTypestringrequired
Enum:"AUDIT""WEB_JOURNEY"
Bodyapplication/json
dataSourcesArray of integers, non-empty

Non-empty array of data sources. Usage for selected data sources only will be shown

dataSourceCreatorsArray of integers, non-empty

Non-empty array of user IDs. Matches data sources that have been created by any of the specified users

dataSourceFoldersArray of objects, non-empty

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

dataSourceLabelsArray of integers, non-empty

Non-empty array of labels present on an item. Matches data sources that have all specified labels

runFrequenciesArray of strings, non-empty

Non-empty array of frequency names. Matches data sources that have any of the specified frequencies

contractTermobject

Select specific contract term. Current term will be shown if omitted

POST
/v3/usage/{itemType}/summary
curl -i -X POST \
  'https://api.observepoint.com/v3/usage/{itemType}/summary' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "dataSources": [
      107239
    ],
    "dataSourceCreators": [
      123
    ],
    "dataSourceFolders": [
      {
        "folderId": 123,
        "domains": [
          123
        ]
      }
    ],
    "dataSourceLabels": [
      223
    ],
    "runFrequencies": [
      "paused"
    ],
    "contractTerm": {
      "startDateInclusive": "2019-08-24",
      "endDateInclusive": "2019-08-24"
    }
  }'

Responses

Specific item type usage summary

Bodyapplication/json
currentContractTermobjectrequired

Contract start and end dates

contractTermsArray of objects, >= 0 itemsrequired

Dates of contracts

usageobjectrequired
Response
{
  "currentContractTerm": {
    "startDateInclusive": "2019-08-24",
    "endDateInclusive": "2019-08-24"
  },
  "contractTerms": [
    { … }
  ],
  "usage": {
    "itemType": "AUDIT",
    "cumulativeTotal": { … },
    "termLimit": 0,
    "limitNoteType": "UNLIMITED",
    "cumulativePacing": 0,
    "overLimitPrice": { … }
  }
}