accounts_table_query

Run a Customer Analytics accounts table query.

post/api/projects/{project_id}/accounts_table_query/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/accounts_table_query/
  • Auth: HTTP bearer

Path parameters

project_idstring required

Project ID of the project you're trying to access. To find the ID of the project, make a call to /api/projects/.

Request body

asyncboolean nullable
client_query_idstring nullable

Client-provided query ID for checking status or canceling an asynchronous query.

limit_contextunknown
namestring nullable

Name given to a query. It's used to identify the query in the UI. Up to 128 characters for a name.

refresh'async' | 'async_except_on_cache_miss' | 'blocking' | 'force_async' | 'force_blocking' | 'force_cache' | 'lazy_async'
variables_overrideobject nullable

Response

errorstring nullable

Query error. Returned only if 'explain' or modifiers.debug is true. Throws an error otherwise.

hasMoreboolean required
hogqlstring nullable

Generated HogQL query.

kind'AccountsTableQuery'
limitinteger required
metricsResultsnumber[] nullable

Aggregated values in the same order as the requested metrics.

offsetinteger required

Changes

No recorded changes to this operation across all 1 revision of this API.