Get a activity

Get a tracking activity by the given id.

get

Path parameters

idstringRequired

The id of the activity.

Header parameters

Brand-URLstringRequired

The brand URL of the request. This is used to identify the brand.

Example: YOUR_BRAND_URL

Auth-KeystringRequired

This is used to authenticate the request. If the request is not authenticated, the server will return a 401 Unauthorized response.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

401

The user is not authorized to access the requested resource. The request is missing the required Auth-Key header.

application/json

429

The user has exceeded the rate limit.

application/json

get

HTTPcURLJavaScriptPython

GET /api/v1/tracking-activities/{id} HTTP/1.1
Host: protocol.jframework.io
Brand-URL: text
Auth-Key: text
Accept: */*

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "id": "sApKpllz4sAplsmzha",
    "user": {
      "id": "Plamxinzg18snza",
      "code": "EXAMPLE",
      "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
      "packageId": "1Plamxinzg18snza",
      "packageCode": "PACKAGE",
      "emailAddress": "[email protected]",
      "nickName": "example",
      "roles": [
        "admin",
        "support"
      ]
    },
    "deviceId": "device_id",
    "event": {
      "id": "sApKpllz4sAplsmzha",
      "guid": "00000000-0000-0000-0000-000000000000",
      "groupCodeName": "Example",
      "code": "CODE",
      "name": "Name",
      "description": "Description",
      "trackingLevel": 1,
      "tags": "Tags",
      "zOrder": 1,
      "status": "Active",
      "isSystem": false
    },
    "url": "https://example.com/page",
    "ipAddress": "192.168.1.1",
    "os": "Windows 10",
    "browserName": "Chrome",
    "browserVersion": "95.0.4638.69",
    "requestFromMobile": false,
    "userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/95.0.4638.69 Safari/537.36",
    "location": "New York, USA",
    "latitude": 40.7128,
    "longitude": -74.006,
    "description": "User visited the homepage.",
    "tags": "#homepage #visit #tracking"
  },
  "errors": []
}