Pull executive report data for a customer

As a Reseller you can search executive reports and retrieve executive report widget data (raw metrics) for a customer. Get the customer's Company ID, then call the executive-report endpoints with X-KEEPNET-Company-Id so data is scoped to that company. Use a credential with Client Role = Reseller.

---

POST /api/companies/search

Get the customer's Company ID. Use the resourceId of the desired company in the next steps.

Retrieves a paginated list of all companies you manage with license details. Each item includes resourceId — use it as the Company ID for scoped requests. 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:24:45.761Z",
        "createTime": "2026-03-09T18:24:45.761Z",
        "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:24:45.761Z",
            "createTime": "2026-03-09T18:24:45.761Z",
            "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"
  ]
}

From the response, pick the company and note its resourceId. Example: "resourceId": "xC5kfGz7w2Nz" → use as X-KEEPNET-Company-Id in the executive-report requests below.

---

POST /api/executive-report/search

Returns a list of executive reports for that customer. Send X-KEEPNET-Company-Id. Request body: see Endpoints → ExecutiveReport for the search schema (e.g. filter, date range).

Search executive report. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>.

Search executive report

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

namestring · nullableOptional

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/executive-report/search

HTTPcURLJavaScriptPython

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

{
  "name": "text"
}

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

200

OK

{
  "data": [
    {
      "resourceId": "text",
      "companyId": 1,
      "name": "text",
      "isEditable": true,
      "isDeletable": true,
      "description": "text",
      "isSupportManager": true
    }
  ],
  "status": "text",
  "message": "text",
  "validationMessages": [
    "text"
  ]
}

---

POST /api/executive-report/get-widget-datas

Returns widget data (raw metrics) for executive reports — e.g. phishing, training, high-level KPIs. Send X-KEEPNET-Company-Id so widget data is for that customer. Request body: see Endpoints → ExecutiveReport → Get widget data list.

Get widget data list. As a Reseller, send X-KEEPNET-Company-Id: <companyResourceId>.

Get widget data list

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

widgetIdsstring[] · nullableOptional

datePeriodstringOptional

startDatestring · date-time · nullableOptional

endDatestring · date-time · nullableOptional

Responses

200

OK

application/json

statusstringOptional

messagestring · nullableOptional

validationMessagesstring[] · nullableOptional

post

/api/executive-report/get-widget-datas

HTTPcURLJavaScriptPython

POST /api/executive-report/get-widget-datas HTTP/1.1
Host: api.keepnetlabs.com
Authorization: Bearer YOUR_OAUTH2_TOKEN
Content-Type: application/json-patch+json
Accept: */*
Content-Length: 118

{
  "widgetIds": [
    "text"
  ],
  "datePeriod": "text",
  "startDate": "2026-03-09T18:24:45.761Z",
  "endDate": "2026-03-09T18:24:45.761Z"
}

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

200

OK

{
  "data": [
    {
      "resourceId": "text",
      "name": "text",
      "description": "text",
      "chartType": "text",
      "widgetDatas": [
        {
          "date": "2026-03-09T18:24:45.761Z",
          "dataObject": null,
          "values": [
            {
              "value": 1,
              "label": "text",
              "name": "text",
              "annotations": null
            }
          ],
          "tableValues": [
            {
              "ANY_ADDITIONAL_PROPERTY": "anything"
            }
          ],
          "tableDefinitions": [
            {
              "label": "text",
              "name": "text"
            }
          ]
        }
      ],
      "widgetType": "text"
    }
  ],
  "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 → ExecutiveReport for the request schema.

Related: Scope API requests to a customer →. View customer's enrollment list and report →. View customer's campaign list and report →.