warehouse_view_link

Create, Read, Update and Delete View Columns.

post/api/projects/{project_id}/warehouse_view_link/validate/

Request

  • Base URL: https://us.posthog.com
  • URL: https://us.posthog.com/api/projects/{project_id}/warehouse_view_link/validate/
  • Auth: none declared

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

joining_table_namestring required

Name of the table or view being joined onto the source table.

joining_table_keystring required

Column or HogQL expression on the joining table used as the join key.

source_table_namestring required

Name of the table the join starts from, for example events.

source_table_keystring required

Column or HogQL expression on the source table used as the join key.

Response

is_validboolean required

Whether the join compiled and returned rows when executed against a sample of the source table.

msgstring nullable required

Warning about the validation result, for example when the sampled join returned no rows.

hogqlstring nullable required

The HogQL statement used to validate the join.

columnsstring[] required

Column names for each row in results.

total_rowsinteger nullable required

Number of sampled source rows checked for a join match, at most 10000. Null when the match-rate query failed.

matched_rowsinteger nullable required

Number of sampled source rows with at least one match in the joining table. Null when the match-rate query failed.

match_ratenumber double nullable required

matched_rows divided by total_rows, between 0 and 1. Null when the match-rate query failed or no rows were sampled.

Changes

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