KuikCodeDocs
APIReferenceAnalytics

List scans

GET
/scans

Every scan in the workspace, newest first, optionally narrowed to a code, a folder or a tag.

AuthorizationBearer <token>

An API key from Settings, Developers: Authorization: Bearer kc_live_...

In: header

Query Parameters

limit?integer

Items per page, 1 to 100.

Range1 <= value <= 100
Default50
cursor?string

The next_cursor from the previous page. Omit for the first page.

from?string

ISO 8601 start, inclusive. Omit for the start of the plan's history.

Formatdate-time
to?string

ISO 8601 end, exclusive. Omit for now.

Formatdate-time
codeId?string

One code (its id).

folderId?string

Codes in this folder and its subfolders.

tag?string

Response Body

application/json

application/json

curl -X GET "https://example.com/scans"
{  "data": [    {      "id": "string",      "timestamp": "2019-08-24T14:15:22Z",      "code": {        "id": "string",        "shortCode": "string"      },      "country": "string",      "region": "string",      "city": "string",      "latitude": 0,      "longitude": 0,      "gps": {        "latitude": 0,        "longitude": 0,        "accuracy": 0      },      "deviceType": "string",      "os": "string",      "browser": "string",      "language": "string",      "referrer": "string",      "timezone": "string",      "destinationUrl": "string",      "matchedRule": "string",      "visitor": "string"    }  ],  "next_cursor": "string",  "window": {    "from": "2019-08-24T14:15:22Z",    "to": "2019-08-24T14:15:22Z",    "clamped": true  }}