Get activities

Get the list of tracking activities.

get

Query parameters

UserIdstringOptional

Filter by user id.

DeviceIdstringOptional

Filter by device id.

TrackingEventIdstringOptional

Filter by tracking event id.

URLstringOptional

Filter by the URL requested.

IpAddressstringOptional

Filter by the ip address.

OsstringOptional

Filter by the os.

BrowserNamestringOptional

Filter by the browser name.

BrowserVersionstringOptional

Filter by the browser version.

RequestFromMobilebooleanOptional

Filter by the request from mobile.

UserAgentstringOptional

Filter by the user agent.

LocationstringOptional

Filter by the location.

Latitudenumber · doubleOptional

Filter by the latitude.

Longitudenumber · doubleOptional

Filter by the longitude.

DescriptionstringOptional

Filter by the description.

TagsstringOptional

Filter by the tags.

KeywordsstringOptional

Filter by the keywords.

SortDataFieldstringOptional

The sort data field to sort. By default, the value is ID.

SortOrderstring · enumOptional

Specifies the sorting order type for a collection.

Possible values:

PageNumberinteger · int32Optional

The page number of the pagination. Default value is 0.

PageSizeinteger · int32Optional

The page size of the pagination. Default value is 200.

Header parameters

Brand-URLstringRequired

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

Example: YOUR_BRAND_URL

Auth-KeystringRequired

Auth-Key is required to authenticate the request. If missing, the server will return 401 Unauthorized.

Example: YOUR_AUTH_KEY

Responses

200

The request was successful.

application/json

This provides interfaces for API responses with data.

successbooleanRead-onlyRequired

This is the flag to indicate whether the API call is successful or not.

statusCodeinteger · int32Read-onlyRequired

This is the HTTP status code. This is used to determine the status code to be returned to the client.

messagestring · min: 1Read-onlyRequired

This is the message to be displayed to the user.

401

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

application/json

429

API call exceeded rate limit due to too many requests.

application/json

get

/api/v1/tracking-activities

HTTPcURLJavaScriptPython

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

{
  "success": true,
  "statusCode": 200,
  "message": "The request was successful.",
  "data": {
    "items": [
      {
        "id": "sApKpllz4sAplsmzha",
        "user": {
          "id": "Plamxinzg18snza",
          "code": "EXAMPLE",
          "avatar": "https://www.gravatar.com/avatar/205e460b479e2e5b48aec07710c08d50",
          "packageId": "1Plamxinzg18snza",
          "packageCode": "PACKAGE",
          "emailAddress": "[e-mail]",
          "phoneNumber": "[phone]",
          "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"
      }
    ],
    "totalItems": 1,
    "pageNumber": 0,
    "pageSize": 10
  },
  "errors": []
}