Fieldmotion API Getting started

Power BI

Export Power BI area data

POST /a/PowerBI_getAreaData

Export every tenant work area as an unpaged Power BI row set.

When to use this endpoint

Use PowerBI_getAreaData to obtain the work-area lookup table, principally for joining a customer’s area_id to a readable area.

Authentication and permissions

The request must authenticate with signed API-key fields or a logged-in CRM session so that the tenant database and user context are available. The handler performs no page or role-permission check.

This direct dataset route does not consume the unsigned api_id/api_key pair used by the Power BI connector. Use PowerBI_getData for the self-authenticating connector feed.

Parameters

This endpoint has no operation-specific parameters.

Example request

FM_api('PowerBI_getAreaData');

Example response

[
  {"id":"8","name":"North","lat":"54.60","lng":"-5.93","last_edited":"1727441000","address":"Belfast"}
]

Errors and unusual responses

ResponseCondition
{"error":"not logged in"}No authenticated tenant context is available. Invalid signed credentials can be rejected by the dispatcher before the handler runs.

Legacy application errors may be returned with HTTP 200. Check the decoded response for error, not only the HTTP status.

Behaviour and edge cases

  • Returns id, name, lat, lng, last_edited, and address directly from every row in the tenant locations table.
  • There is no search, date filter, deletion filter, ordering clause, or pagination. Database row order is therefore not guaranteed.
  • The aggregate feed exposes this array as areas_data for module=areas.

See it in Fieldmotion

CRM1

CRM1’s Power BI settings can enable the Areas dataset; the route is not used by an interactive area screen.

CRM2

The connector uses Areas as lookup data for customer work-area IDs; CRM2 does not call this route for its own area UI.

Related endpoints

  • PowerBI_getData is the supported aggregate connector feed and supplies tenant settings to this helper.
  • PowerBI_authenticate establishes the unsigned connector session used by the aggregate feed.