Generate a BMP sensor

POST /api/v1/sensor on bmp.veilroute.dev

POST https://bmp.veilroute.dev/api/v1/sensor

Generates a mobile SDK sensor for the x-acf-sensor-data header.

Request

Headers

X-Api-Key · string · required

Your Akamai BMP API key. May also be sent as Authorization: Bearer <key>.

Content-Type · string · required

Must be application/json.

Body

app · string · required

Identifier of the target mobile app (its package / bundle id, e.g. com.example.app).

language · string

Optional device language hint (for example pt-BR).

Response

sensor · string

The sensor value. Send it as the x-acf-sensor-data header on your request.

deviceId · string

The device identifier bound to this sensor.

platform · string

Always android.

android · string

Android version reported by the sensor (for example 14).

sdkVersion · string

Akamai mobile SDK version (for example 4.2.0).

latencyMs · number

Time VeilRoute spent generating the sensor, in milliseconds.

curl

curl -X POST https://bmp.veilroute.dev/api/v1/sensor \
  -H "Content-Type: application/json" \
  -H "X-Api-Key: $VEILROUTE_KEY" \
  -d '{"app":"com.example.app"}'

200 OK

{
  "sensor": "1.70.0~4~abcd...",
  "deviceId": "f1e2d3c4-...",
  "platform": "android",
  "android": "14",
  "sdkVersion": "4.2.0",
  "latencyMs": 42
}

See Errors for non-200 responses.