Skip to content
v3 API/
/
Get usage trends for spec...

Get usage trends for specified item type

Request

POST /v3/usage/{itemType}/trends
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}/trends
curl -i -X POST \
  'https://api.observepoint.com/v3/usage/{itemType}/trends' \
  -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

Usage trends

Bodyapplication/json
pastPeriodsArray of objectsrequired

Represents all past months

currentPeriodobject

periodTotal and cumulativeTotal calculated for completed runs in current period, periodProjectedTotal and cumulativeProjectedTotal estimated for future runs

futurePeriodsArray of objectsrequired

Represents future months, with projected values

termLimitinteger

Limit of pages scanned (for audits) or runs completed (for web journeys) for the contract term

limitNoteTypestring
Enum:"UNLIMITED""LIMIT_UNDETERMINED"
monthlyPacinginteger

Shows how many pages should be scanned per month to hit the limit by the end of the contract term

Response
{
  "pastPeriods": [
    { … }
  ],
  "currentPeriod": {
    "startDateInclusive": "2019-08-24",
    "endDateExclusive": "2019-08-24",
    "periodTotal": { … },
    "cumulativeTotal": { … },
    "periodProjectedTotal": { … },
    "cumulativeProjectedTotal": { … }
  },
  "futurePeriods": [
    { … }
  ],
  "termLimit": 0,
  "limitNoteType": "UNLIMITED",
  "monthlyPacing": 0
}