Skip to content
/Labels

V2 API

Download OpenAPI description
SCALA-API.openapi.json
SCALA-API.openapi.yaml
Languages
Servers
https://api.observepoint.com/v2/

Tags

Endpoints for managing tags and tag-related operations including tag metadata and configuration

Operations

Rules

Endpoints for managing rules including creation, configuration, assignment, and rule-based validation logic

Operations

Audits

Endpoints for managing audits including creation, configuration, execution, and retrieving audit results and runs

Operations

Sub-Folders

Endpoints for managing sub-folders including creation, configuration, and sub-folder-based audit and journey management

Operations

Manual Journeys

Endpoints for managing manual journeys including real device testing, HAR file ingestion, and journey execution control. These endpoints power Live Connect and HAR Analyzer features in the ObservePoint UI, enabling users to perform manual testing on real devices and analyze HAR files for tag validation and troubleshooting.

For more information, see the HAR File Processing API Recipe.

Operations

Account

Endpoints for managing account settings, configurations, and account-level information

Operations

Users

Endpoints for managing users including creation, authentication, permissions, and user account management

Operations

Labels

Endpoints for managing labels including creation, assignment, and retrieval for organizing audits, journeys, and other resources

Operations

Get list of all labels

Request

GET /v2/labels
Security
API_Key
curl -i -X GET \
  https://api.observepoint.com/v2/labels \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

successful operation

Bodyapplication/jsonArray [
appsArray of numbersrequired
auditsArray of numbersrequired
idinteger(int32)required
mobileJourneyArray of numbersrequired
namestringrequired
rulesArray of numbersrequired
webJourneyArray of numbersrequired
]
Response
application/json
[
  {
    "apps": [ … ],
    "audits": [ … ],
    "id": 0,
    "mobileJourney": [ … ],
    "name": "string",
    "rules": [ … ],
    "webJourney": [ … ]
  }
]

Create new label

Request

POST /v2/labels
Security
API_Key
Bodyapplication/jsonrequired

New label info

namestringrequired
curl -i -X POST \
  https://api.observepoint.com/v2/labels \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

successful operation

Bodyapplication/json
appsArray of numbersrequired
auditsArray of numbersrequired
idinteger(int32)required
mobileJourneyArray of numbersrequired
namestringrequired
rulesArray of numbersrequired
webJourneyArray of numbersrequired
Response
application/json
{
  "apps": [
    0
  ],
  "audits": [
    0
  ],
  "id": 0,
  "mobileJourney": [
    0
  ],
  "name": "string",
  "rules": [
    0
  ],
  "webJourney": [
    0
  ]
}

Update existing label name

Request

PUT /v2/labels/{labelId}
Security
API_Key
Path
labelIdinteger(int32)required
Bodyapplication/jsonrequired

Updated label info

namestringrequired
curl -i -X PUT \
  'https://api.observepoint.com/v2/labels/{labelId}' \
  -H 'Authorization: YOUR_API_KEY_HERE' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "string"
  }'

Responses

successful operation

Bodyapplication/json
appsArray of numbersrequired
auditsArray of numbersrequired
idinteger(int32)required
mobileJourneyArray of numbersrequired
namestringrequired
rulesArray of numbersrequired
webJourneyArray of numbersrequired
Response
application/json
{
  "apps": [
    0
  ],
  "audits": [
    0
  ],
  "id": 0,
  "mobileJourney": [
    0
  ],
  "name": "string",
  "rules": [
    0
  ],
  "webJourney": [
    0
  ]
}

Delete label with given id

Request

DELETE /v2/labels/{labelId}
Security
API_Key
Path
labelIdinteger(int32)required
curl -i -X DELETE \
  'https://api.observepoint.com/v2/labels/{labelId}' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Responses

Label deleted

Folders

Endpoints for managing folders including creation, organization, access control, and folder-based resource management

Operations