Upload one session’s speed probes from a navigating app

POST

/v1/probes

curl --request POST \
  --url https://api.tareky.com/v1/probes \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "sessionId": "example", "points": [ [ "example" ] ], "batchId": "example", "src": "nav", "batches": [ { "sessionId": "example", "points": [ [ "example" ] ], "batchId": "example", "src": "nav" } ] }'

Authorizations

• key
• access_token
• legacy

Parameters

Header Parameters

x-access-key-id

string

Legacy key id (until its sunset)

Request Body^required

Media typeapplication/json

object

sessionId

string

/^[A-Za-z0-9-]{8,64}$/

points

Array<array>

>= 2 items <= 500 items

batchId

Client-chosen id of this batch (a UUID); a retried upload sends the same one

string

/^[A-Za-z0-9-]{8,80}$/

src

What the device was doing: navigating, a detected drive, the web app

string

Allowed values: nav passive web

batches

Array<object>

>= 1 items <= 20 items

object

sessionId

required

string

/^[A-Za-z0-9-]{8,64}$/

points

required

Array<array>

>= 2 items <= 500 items

batchId

Client-chosen id of this batch (a UUID); a retried upload sends the same one

string

/^[A-Za-z0-9-]{8,80}$/

src

What the device was doing: navigating, a detected drive, the web app

string

Allowed values: nav passive web

Responses

202

Media typeapplication/json

object

accepted

required

Traces accepted: the client is done with each (a sampled-out one counts)

integer

>= -9007199254740991 <= 9007199254740991

sampledOut

Of those, how many adaptive sampling dropped (see GET /v1/probes/config sampling). Absent when none were

integer

>= -9007199254740991 <= 9007199254740991

Example^generated

{
  "accepted": 1,
  "sampledOut": 1
}

429

Rate limit or monthly quota exceeded; see Retry-After

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable code, e.g. quota_exceeded, no_route

string

message

required

string

status

required

integer

>= -9007199254740991 <= 9007199254740991

details

For invalid_request: the validation issues

docsUrl

required

string

requestId

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "status": 1,
    "details": "example",
    "docsUrl": "example"
  },
  "requestId": "example"
}

default

Any other error, in the /v1 error envelope

Media typeapplication/json

object

error

required

object

code

required

Stable machine-readable code, e.g. quota_exceeded, no_route

string

message

required

string

status

required

integer

>= -9007199254740991 <= 9007199254740991

details

For invalid_request: the validation issues

docsUrl

required

string

requestId

string

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "status": 1,
    "details": "example",
    "docsUrl": "example"
  },
  "requestId": "example"
}