Pull gamification report data for a customer

As a Reseller you can retrieve gamification (leaderboard) data for a customer — top performers, full leaderboard, user performance, and user timeline — scoped by Company ID. Use a credential with Client Role = Reseller. Send X-KEEPNET-Company-Id on each request so data is for that customer.

---

POST /api/companies/search

Use this to get the customer's Company ID; use the resourceId of the desired company as X-KEEPNET-Company-Id in the leaderboard requests below. Retrieves a paginated list of companies you manage with license details. Test it: Authorize with Client ID/Secret, then Send — request body is pre-filled.

Retrieves a list of all companies

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

Client ID and Client Secret from Company → Company Settings → REST API. Enter credentials to auto-fetch token.

Token URL:

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

pageNumberintegerRequiredExample: 1

pageSizeintegerRequiredExample: 10

orderBystringRequiredExample: CreateTime

ascendingbooleanRequiredExample: false

isTargetUserCountExceededLimitbooleanOptional

If true, only companies exceeding license limit are returned

Example: false

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/companies/search

HTTPcURLJavaScriptPython

POST /api/companies/search HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 126

{
  "pageNumber": 1,
  "pageSize": 10,
  "orderBy": "CreateTime",
  "ascending": false,
  "filter": {
    "Condition": "AND",
    "SearchInputTextValue": ""
  }
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": {
    "limitExceededCompanyCount": 1,
    "pageNumber": 1,
    "pageSize": 1,
    "totalNumberOfPages": 1,
    "totalNumberOfRecords": 1,
    "results": [
      {
        "companyName": "text",
        "companyResourceId": "text",
        "resellerName": "text",
        "industryName": "text",
        "industryResourceId": "text",
        "licenseTypeName": "text",
        "licenseTypeResourceId": "text",
        "isNumberOfUsersLimited": true,
        "numberOfUsers": "text",
        "privacyDurationId": 1,
        "licenceExpired": true,
        "licenseEndDate": "2026-03-09T18:25:06.849Z",
        "createTime": "2026-03-09T18:25:06.849Z",
        "targetUserCount": 1,
        "children": [
          {
            "companyName": "text",
            "companyResourceId": "text",
            "resellerName": "text",
            "industryName": "text",
            "industryResourceId": "text",
            "licenseTypeName": "text",
            "licenseTypeResourceId": "text",
            "isNumberOfUsersLimited": true,
            "numberOfUsers": "text",
            "privacyDurationId": 1,
            "licenceExpired": true,
            "licenseEndDate": "2026-03-09T18:25:06.849Z",
            "createTime": "2026-03-09T18:25:06.849Z",
            "targetUserCount": 1,
            "children": "[Circular Reference]",
            "tags": [
              "text"
            ],
            "deletedTargetUserCount": 1,
            "inactiveTargetUserCount": 1,
            "monthlyActiveUserCount": 1
          }
        ],
        "tags": [
          "text"
        ],
        "deletedTargetUserCount": 1,
        "inactiveTargetUserCount": 1,
        "monthlyActiveUserCount": 1
      }
    ]
  },
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

POST /api/leaderboard/get-top-performers

Returns top leaderboard performers for the customer. Send X-KEEPNET-Company-Id. Request body: see Endpoints → Leaderboard (e.g. date range, filters).

Get top leaderboard performance. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>.

Get Top Leaderboard Performance

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

Client ID and Client Secret from Company → Company Settings → REST API. Enter credentials to auto-fetch token.

Token URL:

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

datePeriodstringOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/leaderboard/get-top-performers

HTTPcURLJavaScriptPython

POST /api/leaderboard/get-top-performers HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 524

{
  "datePeriod": "text",
  "startDate": "2026-03-09T18:25:06.849Z",
  "endDate": "2026-03-09T18:25:06.849Z",
  "filter": {
    "searchInputTextValue": "text",
    "condition": "text",
    "filterGroups": [
      {
        "condition": "text",
        "filterItems": [
          {
            "fieldName": "text",
            "operator": "text",
            "value": "text",
            "dataType": "text"
          }
        ],
        "filterGroups": [
          {
            "condition": "text",
            "filterItems": [
              {
                "fieldName": "text",
                "operator": "text",
                "value": "text",
                "dataType": "text"
              }
            ],
            "filterGroups": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "pagination": {
    "pageNumber": 1,
    "pageSize": 1,
    "orderBy": "text",
    "ascending": true
  }
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": [
    {
      "rank": 1,
      "targetUserResourceId": "text",
      "firstName": "text",
      "email": "text",
      "lastName": "text",
      "department": "text",
      "preferredLanguage": "text",
      "phoneNumber": "text",
      "points": 1,
      "performance": 1,
      "totalRowCount": 1
    }
  ],
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

POST /api/leaderboard/get-all

Returns the full leaderboard for the customer. Send X-KEEPNET-Company-Id.

Get all leaderboard performance. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>.

Get All Leaderboard Performance

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

Client ID and Client Secret from Company → Company Settings → REST API. Enter credentials to auto-fetch token.

Token URL:

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

datePeriodstringOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/leaderboard/get-all

HTTPcURLJavaScriptPython

POST /api/leaderboard/get-all HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 524

{
  "datePeriod": "text",
  "startDate": "2026-03-09T18:25:06.849Z",
  "endDate": "2026-03-09T18:25:06.849Z",
  "filter": {
    "searchInputTextValue": "text",
    "condition": "text",
    "filterGroups": [
      {
        "condition": "text",
        "filterItems": [
          {
            "fieldName": "text",
            "operator": "text",
            "value": "text",
            "dataType": "text"
          }
        ],
        "filterGroups": [
          {
            "condition": "text",
            "filterItems": [
              {
                "fieldName": "text",
                "operator": "text",
                "value": "text",
                "dataType": "text"
              }
            ],
            "filterGroups": "[Circular Reference]"
          }
        ]
      }
    ]
  },
  "pagination": {
    "pageNumber": 1,
    "pageSize": 1,
    "orderBy": "text",
    "ascending": true
  }
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": [
    {
      "rank": 1,
      "targetUserResourceId": "text",
      "firstName": "text",
      "email": "text",
      "lastName": "text",
      "department": "text",
      "preferredLanguage": "text",
      "phoneNumber": "text",
      "points": 1,
      "performance": 1,
      "totalRowCount": 1
    }
  ],
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

POST /api/leaderboard/user-performance

Returns detailed performance for selected users in the customer's gamification data. Send X-KEEPNET-Company-Id.

Get detailed user performance. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>.

Get Detailed User Performance

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

Client ID and Client Secret from Company → Company Settings → REST API. Enter credentials to auto-fetch token.

Token URL:

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

targetUserResourceIdstring · nullableOptional

datePeriodstringOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/leaderboard/user-performance

HTTPcURLJavaScriptPython

POST /api/leaderboard/user-performance HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 127

{
  "targetUserResourceId": "text",
  "datePeriod": "text",
  "startDate": "2026-03-09T18:25:06.849Z",
  "endDate": "2026-03-09T18:25:06.849Z"
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": [
    {
      "rank": 1,
      "phishingTypeId": 1,
      "phishingType": "text",
      "performance": 1,
      "totalPerformance": 1,
      "totalPoints": 1
    }
  ],
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

POST /api/leaderboard/get-user-timeline

Returns timeline data for leaderboard users. Send X-KEEPNET-Company-Id.

Get user timeline for leaderboard. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>.

Get Top Leaderboard Performance

post

Required scopes

This endpoint requires the following scopes:

• : API

Authorizations

oauth2bearerAuth

OAuth2clientCredentialsRequired

Client ID and Client Secret from Company → Company Settings → REST API. Enter credentials to auto-fetch token.

Token URL:

Body

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

targetUserResourceIdstring · nullableOptional

actionTypesstring[] · nullableOptional

difficultyTypesstring[] · nullableOptional

productsstring[] · nullableOptional

datePeriodstringOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

showOnlyFailedEventsbooleanOptional

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/leaderboard/get-user-timeline

HTTPcURLJavaScriptPython

POST /api/leaderboard/get-user-timeline HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 302

{
  "targetUserResourceId": "text",
  "actionTypes": [
    "text"
  ],
  "difficultyTypes": [
    "text"
  ],
  "products": [
    "text"
  ],
  "datePeriod": "text",
  "startDate": "2026-03-09T18:25:06.849Z",
  "endDate": "2026-03-09T18:25:06.849Z",
  "pagination": {
    "pageNumber": 1,
    "pageSize": 1,
    "orderBy": "text",
    "ascending": true
  },
  "showOnlyFailedEvents": true
}

application/json-patch+jsonapplication/jsontext/jsonapplication/*+json

200

OK

{
  "data": [
    {
      "resourceId": "text",
      "name": "text",
      "timeZoneId": "text",
      "campaignPerformance": 1,
      "difficultyType": "text",
      "points": 1,
      "ActionTime": "text",
      "ActionTimeWithDay": "text",
      "trainingType": 1,
      "categoryDescription": "text",
      "result": "text",
      "campaignType": "text",
      "productType": "text",
      "ActionType": "text",
      "pointRule": {
        "ruleName": "text",
        "earned": true,
        "lostPoints": 1,
        "rulePoint": 1,
        "lastPoint": 1
      }
    }
  ],
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

Common errors

• 403 Forbidden — Credential is not Reseller, or the Company ID is not one you manage. Set Client Role = Reseller. Roles and permissions →

• 401 Unauthorized — Missing or invalid token. Request a new token via POST /connect/token.

• 404 Not Found / 400 Bad Request — Invalid Company ID or invalid request body. Verify Company ID from POST /api/companies/search and check Endpoints → Leaderboard for the request schema.

Related: Pull executive report data for a customer →. Scope API requests to a customer →. Export gamification leaderboard for a customer →.