BI Export API overview — datasets and endpoints in Allocadia

The BI Export API exposes Allocadia data as CSVs for downstream analytics. Here are the datasets, endpoints, and the ZIP-of-all pattern.


The two endpoints

The BI Export API offers two patterns for pulling data:

  • Single CSV — GET /biexports/{dataset}.csv returns one dataset as a CSV.
  • ZIP of all — GET /biexports/all.zip returns every dataset as a bundle. This endpoint is asynchronous — see below.

Base URL: https://api-na.allocadia.com/v1 (or api-eu for European tenants).

The 14 datasets

  • folder_budget — folder/budget hierarchy with rollup fields.
  • folder_budgetmeasures — rollup and grand total metric values.
  • category — categories and sub-categories.
  • lineitem — line item attributes.
  • itemmeasures — line item metric values.
  • po_actual — PO and Actual records with mapping status.
  • fydate — fiscal and calendar year date dimensions.
  • currency — currency dimension (multi-currency accounts).
  • targettransfers — transfer requests (V8+).
  • activity, activitymeasures, activity_hierarchy, activity_budget — Plan-side activity data (V11+).
  • lineitem_allocation — line item allocation details (V11, Apr 2025+).

Note: campaign and campaignmeasures appear in all.zip but are legacy and empty for most customers. Don't use them.

Asynchronous ZIP export

The /biexports/all.zip endpoint is asynchronous:

  1. The first call returns HTTP 202 Accepted with a Location header pointing to the job status URL.
  2. Poll the status URL (GET) until the job reports complete.
  3. When complete, the job object's location field points to the ZIP file — fetch that.

Alternatively, supply success_callback_url and/or failure_callback_url on the initial call; the result is pushed to you when ready.

Dataset availability vs project version

Datasets expand with your GoodData project version. V11 is the current baseline. If a dataset you expect returns empty or 404, your account may be on an older version — see What changes during a fiscal-year rollover in Allocadia, and what doesn't? for context.

Related articles

Was this article helpful?

Comments

0 comments

Please sign in to leave a comment.