Export gamification leaderboard for a customer

As a Reseller you export the gamification leaderboard or user timeline for a customer to CSV or Excel for reporting, MSSP dashboards, or audits. Use a credential with Client Role = Reseller. Send X-KEEPNET-Company-Id so the export is scoped to that company.

---

POST /api/companies/search

Use this to get the customer's Company ID; use the resourceId as X-KEEPNET-Company-Id in the export requests below. Retrieves a paginated list of companies you manage. Test it: Authorize with Client ID/Secret, then Send.

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-09T17:38:24.142Z",
        "createTime": "2026-03-09T17:38:24.142Z",
        "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-09T17:38:24.142Z",
            "createTime": "2026-03-09T17:38:24.142Z",
            "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-all/export

Exports the full leaderboard for the customer to a file (e.g. CSV or Excel). Send X-KEEPNET-Company-Id. Request body: see Endpoints → Leaderboard (e.g. LeaderboardSearchExportRequestParameter — date range, export format).

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

Export 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

exportTypestringOptional

reportAllPagesbooleanOptional

datePeriodstringOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

Responses

200

OK

No content

post

/api/leaderboard/get-all/export

HTTPcURLJavaScriptPython

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

{
  "exportType": "text",
  "reportAllPages": true,
  "datePeriod": "text",
  "startDate": "2026-03-09T17:38:24.142Z",
  "endDate": "2026-03-09T17:38:24.142Z",
  "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

No content

---

POST /api/leaderboard/get-user-timeline/export

Exports user timeline data for the customer to a file. Send X-KEEPNET-Company-Id. Request body: see Endpoints → Leaderboard (e.g. LeaderboardUserTimelineExportRequestParameter).

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

Export User Timeline

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

exportTypestringOptional

reportAllPagesbooleanOptional

targetUserResourceIdstring · nullableOptional

actionTypesstring[] · nullableOptional

difficultyTypesstring[] · nullableOptional

productsstring[] · nullableOptional

datePeriodstringOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

showOnlyFailedEventsbooleanOptional

Responses

200

OK

No content

post

/api/leaderboard/get-user-timeline/export

HTTPcURLJavaScriptPython

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

{
  "exportType": "text",
  "reportAllPages": true,
  "targetUserResourceId": "text",
  "actionTypes": [
    "text"
  ],
  "difficultyTypes": [
    "text"
  ],
  "products": [
    "text"
  ],
  "datePeriod": "text",
  "startDate": "2026-03-09T17:38:24.142Z",
  "endDate": "2026-03-09T17:38:24.142Z",
  "pagination": {
    "pageNumber": 1,
    "pageSize": 1,
    "orderBy": "text",
    "ascending": true
  },
  "showOnlyFailedEvents": true
}

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

200

OK

No content

---

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.

• 400 Bad Request — Invalid request body or export format. Check Endpoints → Leaderboard for the export request schema.

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