> For the complete documentation index, see [llms.txt](https://docs.bipeye.com/product-docs/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.bipeye.com/product-docs/overview/openapi/models.md).

# Models

## The EmbedLinkSecuritySummary object

```json
{"openapi":"3.0.0","info":{"title":"BI.P.EYE API","version":"1.0.0"},"components":{"schemas":{"EmbedLinkSecuritySummary":{"type":"object","properties":{"hasPassword":{"type":"boolean"},"allowedIps":{"type":"array","items":{"type":"string"}},"allowedDomains":{"type":"array","items":{"type":"string"}}},"required":["hasPassword","allowedIps","allowedDomains"],"description":"The link's access rules as stored. The password itself is never returned."}}}}
```

## The Filter object

```json
{"openapi":"3.0.0","info":{"title":"BI.P.EYE API","version":"1.0.0"},"components":{"schemas":{"Filter":{"type":"object","properties":{"jsonPath":{"type":"string","minLength":1,"description":"JSON path to the field being filtered"},"type":{"$ref":"#/components/schemas/FiltersTypes"},"value":{"nullable":true}},"required":["jsonPath","type"]},"FiltersTypes":{"type":"string","enum":["is greater than","is less than","is greater than or equal to","is less than or equal to","is","is not","date range","multi select","days back","is exists","is not exists","includes","not includes"]}}}}
```

## The FiltersTypes object

```json
{"openapi":"3.0.0","info":{"title":"BI.P.EYE API","version":"1.0.0"},"components":{"schemas":{"FiltersTypes":{"type":"string","enum":["is greater than","is less than","is greater than or equal to","is less than or equal to","is","is not","date range","multi select","days back","is exists","is not exists","includes","not includes"]}}}}
```

## The EmbedLinkSecurity object

```json
{"openapi":"3.0.0","info":{"title":"BI.P.EYE API","version":"1.0.0"},"components":{"schemas":{"EmbedLinkSecurity":{"type":"object","properties":{"password":{"type":"string","minLength":8,"description":"Viewers enter this password before the dashboard opens. 8 to 72 characters. Stored hashed; it is never returned."},"allowedIps":{"type":"array","items":{"type":"string"},"maxItems":100,"description":"Visitor IPs the link opens from, at most 100. Single addresses and CIDR ranges, IPv4 and IPv6. Checked on the embed page and on every data request the dashboard makes. An empty list means no IP restriction."},"allowedDomains":{"type":"array","items":{"type":"string"},"maxItems":50,"description":"Sites allowed to show the link in an iframe, at most 50. A domain (`app.example.com`, which also covers its subdomains), a wildcard (`*.example.com`), or an origin with a scheme and port (`http://localhost:3000`). Enforced by the browser (Content-Security-Policy `frame-ancestors`), and opening the link outside an iframe is refused. An empty list means no domain restriction."}},"additionalProperties":false,"description":"Access rules for this link only. They apply in addition to the dashboard's own IP and domain restrictions set in the BI.P.EYE app: a viewer must pass both."}}}}
```

## The DashboardDatasetsResponse object

```json
{"openapi":"3.0.0","info":{"title":"BI.P.EYE API","version":"1.0.0"},"components":{"schemas":{"DashboardDatasetsResponse":{"type":"object","properties":{"datasets":{"type":"array","items":{"$ref":"#/components/schemas/Dataset"}}},"required":["datasets"]},"Dataset":{"type":"object","properties":{"datasetId":{"type":"string","format":"uuid","description":"The UUID of the dataset"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DatasetField"}}},"required":["datasetId","fields"]},"DatasetField":{"type":"object","properties":{"jsonPath":{"type":"string","description":"JSONPath of the field within the dataset"},"type":{"$ref":"#/components/schemas/FieldType"}},"required":["jsonPath","type"]},"FieldType":{"type":"string","enum":["string","boolean","number","bigint"]}}}}
```

## The Dataset object

```json
{"openapi":"3.0.0","info":{"title":"BI.P.EYE API","version":"1.0.0"},"components":{"schemas":{"Dataset":{"type":"object","properties":{"datasetId":{"type":"string","format":"uuid","description":"The UUID of the dataset"},"fields":{"type":"array","items":{"$ref":"#/components/schemas/DatasetField"}}},"required":["datasetId","fields"]},"DatasetField":{"type":"object","properties":{"jsonPath":{"type":"string","description":"JSONPath of the field within the dataset"},"type":{"$ref":"#/components/schemas/FieldType"}},"required":["jsonPath","type"]},"FieldType":{"type":"string","enum":["string","boolean","number","bigint"]}}}}
```

## The DatasetField object

```json
{"openapi":"3.0.0","info":{"title":"BI.P.EYE API","version":"1.0.0"},"components":{"schemas":{"DatasetField":{"type":"object","properties":{"jsonPath":{"type":"string","description":"JSONPath of the field within the dataset"},"type":{"$ref":"#/components/schemas/FieldType"}},"required":["jsonPath","type"]},"FieldType":{"type":"string","enum":["string","boolean","number","bigint"]}}}}
```

## The FieldType object

```json
{"openapi":"3.0.0","info":{"title":"BI.P.EYE API","version":"1.0.0"},"components":{"schemas":{"FieldType":{"type":"string","enum":["string","boolean","number","bigint"]}}}}
```

## The EditApiKeyResponse object

```json
{"openapi":"3.0.0","info":{"title":"BI.P.EYE API","version":"1.0.0"},"components":{"schemas":{"EditApiKeyResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}
```

## The EmbedLinkSecurityEdit object

```json
{"openapi":"3.0.0","info":{"title":"BI.P.EYE API","version":"1.0.0"},"components":{"schemas":{"EmbedLinkSecurityEdit":{"type":"object","properties":{"password":{"anyOf":[{"type":"string","minLength":8},{"type":"string","enum":[""]},{"nullable":true}],"description":"A new password. `null` or `\"\"` removes the password. Omit to keep the current one."},"allowedIps":{"type":"array","items":{"type":"string"},"maxItems":100,"description":"Replaces the IP list. `[]` removes it. Omit to keep the current one."},"allowedDomains":{"type":"array","items":{"type":"string"},"maxItems":50,"description":"Replaces the domain list. `[]` removes it. Omit to keep the current one."}},"additionalProperties":false,"description":"Changes the link's access rules field by field: a field you send replaces, a field you omit is kept."}}}}
```

## The DeleteApiKeyResponse object

```json
{"openapi":"3.0.0","info":{"title":"BI.P.EYE API","version":"1.0.0"},"components":{"schemas":{"DeleteApiKeyResponse":{"type":"object","properties":{"message":{"type":"string"}},"required":["message"]}}}}
```
