Skip to content

NP6 API Reference (8.1.0)

This documentation provides comprehensive access to the full range of functionalities offered by the NP6 platform through a standardized RESTful interface.

If you have any questions or need assistance, please contact our support team at https://support.chapsvision.com.

Languages
Servers
Production server
https://api-cm.np6.com
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations

Request

Path
targetIdstringrequired

The target’s id

segmentIdinteger(int32)required

The segment’s id

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

curl -i -X POST \
  'https://api-cm.np6.com/targets/{targetId}/segments/{segmentId}' \
  -H 'X-Key: string'

Responses

No Content

Request

Path
targetIdstringrequired

The Id of the target

segmentIdinteger(int32)required

The Id of the segment

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

curl -i -X DELETE \
  'https://api-cm.np6.com/targets/{targetId}/segments/{segmentId}' \
  -H 'X-Key: string'

Responses

No Content

Request

Path
idstringrequired

id of the target

Headers
X-Keystringrequired

A unique API key used to authenticate requests to the NP6 platform. This key must be included in every API call to validate the identity and permissions of the client. Keep your API key secure and do not expose it in public code or logs.

Bodyapplication/vnd.mperf.v8.model.v1+json

comma separated fieldids to filter output

object
curl -i -X GET \
  'https://api-cm.np6.com/targets/{id}' \
  -H 'Content-Type: application/vnd.mperf.v8.model.v1+json' \
  -H 'X-Key: string' \
  -d '{}'

Responses

Body
idstring

The Id of the target

hashstring

The Hash of the target

creationDatestring(date-time)

The creation date of the target

lastUpdateDatestring(date-time)

The last update of the target

fieldsobject

The values of the target defined by the Fields

Response
{ "id": "string", "hash": "string", "creationDate": "2019-08-24T14:15:22Z", "lastUpdateDate": "2019-08-24T14:15:22Z", "fields": {} }
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations
Operations