LiquidPlanner

The LiquidPlanner Developer Hub

Welcome to the LiquidPlanner developer hub. You'll find comprehensive guides and documentation to help you start working with LiquidPlanner as quickly as possible, as well as support if you get stuck. Let's jump right in!

Get Started    

Analytics Reports

You can request the same information as you are able see on the Analytics tab in your workspace.

List reports

To fetch the id, name and report_type for all existing Analytics reports in the workspace:

% curl https://app.liquidplanner.com/api/v1/workspaces/:id/reports

Show a single report

To get the same information for a single report:

% curl https://app.liquidplanner.com/api/v1/workspaces/:id/reports/:id

Run a report and get its content

To run a specific report and get its content:

% curl https://app.liquidplanner.com/api/v1/workspaces/:id/reports/:id/data

Optional Parameters

Parameter

Value

start_date

YYYY-MM-DD formatted dates to override the report’s Date filter; both must be included, if used

end_date

YYYY-MM-DD formatted dates to override the report’s Date filter; both must be included, if used

Example:

% curl https://app.liquidplanner.com/api/v1/workspaces/:id/reports/:id/data?start_date=2017-01-01&end_date=2017-01-31

Updated less than a minute ago

Analytics Reports


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.