Run a VoidQL query
Runs one read-only VoidQL SELECT over the project and returns up to limit rows (100 by default, at most 10,000) with isTruncated when there were more.
getSchema lists the tables and their columns. Running a query changes nothing, so it is safe to repeat. Personal data (people's email, name and traits, and event keys that identify a person, such as properties.$email or context.$ip) needs the project:persons:read permission as well. A query runs for at most 20 seconds.
Guide: Query analytics with VoidQL
Errors
| Status | type | code | When |
|---|---|---|---|
| 400 | invalid_request | voidql_syntax | With a message saying what to change, where param names the field of an unknown one and a rejection names the database's error code. |
| 400 | invalid_request | voidql_unsupported | With a message saying what to change, where param names the field of an unknown one and a rejection names the database's error code. |
| 400 | invalid_request | voidql_unknown_relation | With a message saying what to change, where param names the field of an unknown one and a rejection names the database's error code. |
| 400 | invalid_request | voidql_unknown_field | With a message saying what to change, where param names the field of an unknown one and a rejection names the database's error code. |
| 400 | invalid_request | voidql_too_complex | With a message saying what to change, where param names the field of an unknown one and a rejection names the database's error code. |
| 400 | invalid_request | voidql_rejected | With a message saying what to change, where param names the field of an unknown one and a rejection names the database's error code. |
| 403 | permission_denied | personal_data | For personal data without the permission. |
| 429 | rate_limited | voidql_quota | When the organization runs too many queries. |
| 503 | unavailable | voidql_timeout | When the query could not finish. |
| 503 | unavailable | voidql_memory | When the query could not finish. |
| 503 | unavailable | voidql_unavailable | When the query could not finish. |
It can also fail with the errors every operation shares, such as unauthenticated; see Errors.
More in VoidQL
Something wrong or missing on this page? Tell us by email or on Discord.