Creation API provides endpoints for getting information about the databases and tables and their available languages, validating tables for visualization and creating visualizations from Px file data.
| Function Name | API Route | Parameters | Returns |
|---|---|---|---|
| GetDataBaseListingAsync | GET: data-bases/{dbPath} | dbPath: The path to the database level provided in the url. | DatabaseGroupContents object that contains either the tables or listing groups of the given database level. |
| GetCubeMetaAsync | GET: cube-meta/{tablePath} | tablePath: The path to the table provided in the url. | IReadOnlyMatrixMetadata object that contains the metadata of the table. |
| ValidateTableMetaData | GET: validate-table-metadata/{tablePath} | tablePath: The path to the table provided in the url. | TableMetaValidationResult object that contains the validation result of the table metadata. |
| GetDimensionFilterResultAsync | POST: filter-dimension | filterRequest: FilterRequest object that contains the table path and selected value filters for each dimension. | A dictionary of dimension codes and their value codes that are available based on the filter request. |
| GetEditorContents | POST: editor-contents | request: MatrixQuery object that contains the table path and selected value filters for each dimension. | EditorContentsResponse object that contains all the information the visualization editor needs to allow the user to create a visualization including default header, information about the query size and size limits, options and rules for available visualization types and rejection reasons for the unavailable visualization types. |
| GetVisualizationRulesAsync | POST: visualization-rules | rulesQuery: VisualizationSettingsRequest object that contains visualization settings including the selected visualization type and the CubeQuery object representing the data for the visualization. | VisualizationRules object that defines which settings are available for tweaking the visualization in the front end user interface such as sorting options, pivoting options, displaying data labels etc. |
| GetVisualizationAsync | POST: visualization | request: ChartRequest object that contains the CubeQuery, selected language, active selectable dimensions and VisualizationCreationSettings object that contains the visualization type, dimension codes for rows and columns, and settings for the given visualization type. | VisualizationResponse object that contains the data that PxVisualizer needs to render the visualization in the front end user interface including the data, settings and metadata. |
Info API provides information about the application through its one GET endpoint. It returns an object that contains the name and version of the application and the environment that it's running in.
Query meta API provides an endpoint for retrieving metadata of a saved query.
| Function Name | API Route | Parameters | Returns |
|---|---|---|---|
| GetQueryMeta | GET: {savedQueryId} | savedQueryId: The id of the saved query provided in the url. | QueryMetaResponse object that contains the metadata of the saved query including the header, archival status, selected visualization type, etc. |
SQ api provides endpoints for retrieving, saving, archiving and re-archiving queries. When saving, archiving or re-archiving queries, if an id is provided with the SaveQueryParams object and a draft state saved query file is found, it is overwritten. If no id is provided, or the previously saved query is not in draft state, a new id is generated for the query. Optional webhook can be configured to be called when a query is saved as publish-ready.
| Function Name | API Route | Parameters | Returns |
|---|---|---|---|
| GetSavedQueryAsync | GET: {savedQueryId} | savedQueryId: The id of the saved query provided in the url. | SaveQueryParams object that contains the CubeQuery and VisualizationCreationSettings objects that represent the saved query and its visualization settings. |
| SaveQueryAsync | POST: save | parameters: SaveQueryParams object that contains the CubeQuery and VisualizationCreationSettings objects that represent the query and its visualization settings. | SaveQueryResponse object that contains the id of the saved query. |
| ArchiveQueryAsync | POST: archive | parameters: SaveQueryParams object that contains the CubeQuery and VisualizationCreationSettings objects that represent the query and its visualization settings. | SaveQueryResponse object that contains the id of the archived query. |
| RearchiveQueryAsync | POST: re-archive | request: ReArchiveRequest object that contains the id of the archived query that is to be re-archived. | ReArchiveResponse object that contains the id of the new archived query. |
Visualization API provides an endpoint for retrieving data required for rendering a saved visualization.
| Function Name | API Route | Parameters | Returns |
|---|---|---|---|
| GetVisualization | GET: {sqId} | sqId: The id of the saved query provided in the url. | VisualizationResponse object that contains the data that PxVisualizer needs to render the visualization in the front end user interface including the data, settings and metadata. |
Health API provides an endpoint for checking the health of all configured dependencies. It probes the database connection, saved query storage, archive file storage, and optionally the publication webhook service (when configured with a health check endpoint). Returns HTTP 200 with a HealthResponse when all probes are healthy, or HTTP 503 when any probe is unhealthy.
| Function Name | API Route | Parameters | Returns |
|---|---|---|---|
| GetHealthAsync | GET | None | HealthResponse object containing overall status ("healthy" or "unhealthy"), a list of DatabaseHealthStatus objects for each database probe, and a list of ServiceHealthStatus objects for each service probe (saved-query-storage, archive-file-storage, and optionally publication-webhook). |