Data Analysis management API operations

This is a documentation about data analysis API operations that are not CRUD or data processing.

Operations

DataCollector generate results from directives

Generate DataCollectorResult entities for the given DataCollector based on the directives. Works only for SQL as of now, this generates results based on AS "foobar" statements.

Endpoint: POST /dataanalysis_datacollectors/{id}/generate/results

Body: No parameters needed.

DataCollector generate parameters from directives

Generate DataCollectorParameter entities for the given DataCollector based on the directives. Works only for SQL as of now, this generates results based on :foobar parameters.

Endpoint: POST /dataanalysis_datacollectors/{id}/generate/parameters

Body: No parameters needed.

DataCollector generate filters from parameters

Generate Dashboard Filter entities for the given DataCollector based on the existing collector’s parameters.

Endpoint: POST /dataanalysis_datacollectors/{id}/generate/filters

Body: No parameters needed.

Generate DataProcessor from DataCollector

Generate a DataProcessor based on the DataCollector. Also generates the DataProcessorResult entities based on the DataCollector’s results.

Endpoint: POST /dataanalysis_datacollectors/{id}/generate/data_processor

Body: No parameters needed.

Generate Complete listing widget from DataCollector

Generate a default listing widget with all relations (DataProcessor, processor results, widget, template) based on the DataCollector.

Endpoint: POST /dataanalysis_datacollectors/{id}/generate/widget/listing

Body: No parameters needed.

Generate Complete summary widget from DataCollector

Generate a default summary widget with all relations (DataProcessor, processor results, widget, template) based on the DataCollector.

Endpoint: POST /dataanalysis_datacollectors/{id}/generate/widget/summary

Body: No parameters needed.

Generate Complete graph widget from DataCollector

Generate a default line graph widget with all relations (DataProcessor, processor results, widget, template) based on the DataCollector.

Endpoint: POST /dataanalysis_datacollectors/{id}/generate/widget/graph

Body: No parameters needed.

DataCollector get raw query

Return the collector’s directives with parameters entered dirctly in the query. Useful for debugging.

Endpoint: GET /dataanalysis_datacollectors/{id}/get_query

Parameters are sent in querystring.

Dashboard Report export complete report

Export the complete report, including all relations, into a JSON file.

Endpoint: GET /dashboard_reports/{id}/export/complete

Dashboard Report import complete report

Import the complete report, including all relations, from a JSON file.

Endpoint: POST /dashboard_reports/{id}/import/complete

Body: File upload in binary multipart/form-data with property file.