# Get the company's identity insights

Needs the insights area at view.

`GET /api/v1/public/workspaces/workspaceId/enterprise/insights`

- Sign-in: A signed-in user's session: send the session id in the x-session-id header.
- Rate limit: Up to 500 requests every 3 seconds per IP address; up to 1,000 requests a minute per API key (some requests are not counted).

Needs the `insights` area at `view`. `days` must be 7, 30 or 90 (400 `invalid_days`); limited to the app plan's audit retention window.

## Request

| Field         | Type   | Required | Constraints | Description |
| ------------- | ------ | -------- | ----------- | ----------- |
| `workspaceId` | string | Yes      | -           | -           |

## Example request

Replace each `YOUR_...` value with your own, and set the credential in the environment variable the sample reads.

```bash title="cURL"
curl -X GET "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/insights" \
  -H "x-session-id: $BUILDBASE_SESSION_ID"
```

```ts title="TypeScript"
const response = await fetch(
  'https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/insights',
  {
    method: 'GET',
    headers: {
      'x-session-id': process.env.BUILDBASE_SESSION_ID ?? '',
    },
  }
);
if (!response.ok) {
  throw new Error(`${response.status}: ${await response.text()}`);
}
const data = await response.json();
```

```python title="Python"
import os

import requests

response = requests.get(
    "https://api.console.buildbase.app/api/v1/public/workspaces/YOUR_WORKSPACE_ID/enterprise/insights",
    headers={
        "x-session-id": os.environ["BUILDBASE_SESSION_ID"],
    },
    timeout=30,
)
response.raise_for_status()
data = response.json()
```

## Responses

### 200 OK

OK

```json title="Example"
{
  "agents": {
    "byReason": {},
    "granted": 0,
    "people": 0,
    "refused": 0
  },
  "appTeam": {
    "refused": 0,
    "sessions": 0
  },
  "daily": [
    {
      "day": "2026-10-12",
      "refusals": 0,
      "signIns": 0
    },
    {
      "day": "2026-10-13",
      "refusals": 0,
      "signIns": 0
    },
    {
      "day": "2026-10-14",
      "refusals": 0,
      "signIns": 0
    },
    {
      "day": "2026-10-15",
      "refusals": 0,
      "signIns": 0
    },
    {
      "day": "2026-10-16",
      "refusals": 0,
      "signIns": 0
    },
    {
      "day": "2026-10-17",
      "refusals": 0,
      "signIns": 0
    },
    {
      "day": "2026-10-18",
      "refusals": 0,
      "signIns": 0
    },
    {
      "day": "2026-10-19",
      "refusals": 0,
      "signIns": 0
    },
    {
      "day": "2026-10-20",
      "refusals": 0,
      "signIns": 0
    },
    {
      "day": "2026-10-21",
      "refusals": 0,
      "signIns": 0
    }
  ],
  "days": 30,
  "from": "2026-01-01T00:00:00.000Z",
  "health": {
    "certificate": null,
    "connection": "active",
    "connections": [
      {
        "label": "Okta",
        "state": "active"
      }
    ],
    "directory": null,
    "streams": [
      {
        "kind": "https",
        "name": "Acme SIEM",
        "state": "active"
      },
      {
        "kind": "splunk",
        "name": "Splunk",
        "state": "active"
      }
    ]
  },
  "people": {
    "active": 5,
    "inactive": 0,
    "notSignedIn": 0,
    "provisioned": 0,
    "signedIn": 5,
    "total": 5,
    "viaDomain": 0,
    "viaSso": 5
  },
  "refusals": {
    "byReason": [
      {
        "count": 1,
        "reason": "sso_email_mismatch"
      }
    ],
    "network": {
      "requests": 0,
      "signIns": 0
    },
    "requests": 0,
    "topEmails": [
      {
        "count": 1,
        "email": "user@example.com"
      }
    ],
    "total": 1,
    "workspaces": {
      "byReason": {},
      "refused": 0
    }
  },
  "signIns": {
    "breakGlass": 0,
    "byConnection": [
      {
        "count": 6,
        "label": "Okta",
        "ref": "d6c231291bea80e7",
        "type": "OktaSAML"
      }
    ],
    "firstTime": 5,
    "fromIdp": 0,
    "people": 5,
    "total": 6
  },
  "to": "2026-01-01T00:00:00.000Z",
  "workloads": {
    "byReason": {},
    "credentials": 0,
    "issued": 0,
    "refused": 0
  }
}
```

### Any other status

Any other answer the handler sends itself (its own refusals). Not described yet.

## Errors

Each refusal, what it means, and what to do. The request changed nothing.

### 401 Unauthorized

**What it means:** The credential is missing, expired or not accepted here, or the caller's role has no grant for `x-permission` (refused with 401 too). The body is the plain text `Unauthorized`, or a JSON body with a `code` where the gate says why.

**What to do:** Send the credential this operation asks for (see Sign-in above), or sign in again if it expired. A valid credential is also refused when the role has no grant for the permission above.

```text title="Example"
Unauthorized
```

### 429 Too Many Requests

**What it means:** A rate limit in `x-rateLimit` was reached. `retryAfter` and the `Retry-After` header say how many seconds until the window resets.

**What to do:** Wait the number of seconds in the `Retry-After` header (also `retryAfter` in the body), then retry. Slow down repeated calls.

```json title="Example"
{
  "success": false,
  "message": "string",
  "reason": "rate_limited",
  "retryAfter": 1
}
```

## Related

- [Workspaces guide](/workspaces/overview): how this part of BuildBase works
- [All Workspaces operations](/http-api/reference/workspaces)
- [API reference](/http-api/reference): every operation, by tag
- [Sign-in and credentials for the HTTP API](/http-api/authentication)
- [How the HTTP API reports errors](/http-api/errors)
- [Make your first call](/http-api/first-call)
- [Error codes](/reference/error-codes): every `code` the API returns
- OpenAPI: operation `workspaces.enterprise.insights.list` in [public-v1.json](https://docs.buildbase.app/openapi/public-v1.json)
