Accessing Enterprise Dashboard OData Feeds

Owned by Matt Riley
Last updated: Dec 19, 2024 by Jing ChengVersion comment
2 min read

Getting data through PowerBI

Request OData Feed

From the File menu, click “Get Data->OData Feed” or, from the Home menu, click “Get Data->OData feed”

Getting data from the File Menu
Getting Data from the File Menu
home_get.png
Getting Data From the Home Ribbon

Provide the URL for your desired resource

Resource URLs are as follows:

Associated Report

URL

Associated Report

URL

Project Spaces

https://commcarehq.org/a/<domain>/enterprise/api/v1/domain/

Web Users

https://commcarehq.org/a/<domain>/enterprise/api/v1/webuser/

Mobile Workers

https://commcarehq.org/a/<domain>/enterprise/api/v1/mobileuser/

Mobile Form Submissions

https://commcarehq.org/a/<domain>/enterprise/api/v1/formsubmission/
date range can be provided by providing start and/or enddate parameters, i.e.:
https://commcarehq.org/a/<domain>/enterprise/api/v1/formsubmission/?startdate=2024-07-01&enddate=2024-07-05

Dates must be provided in ‘YYYY-MM-DD’ format, and refer to UTC time. If no end date is provided, the report will pull data up until today’s date. If no start date is provided, the 30 days up until (and including) the end date will be fetched. Currently, fetching more than 90 days worth of data is not supported.

OData Feeds

https://commcarehq.org/a/<domain>/enterprise/api/v1/odatafeed/

SMS Usage

https://commcarehq.org/a/<domain>/enterprise/api/v1/sms/
date range can be provided using the same startdate and enddate parameters described in the Mobile Form Submissions section above.

Two Factor Authentication

https://commcarehq.org/a/<domain>/enterprise/api/v1/twofactorauth/

CommCare Version Compliance

https://commcarehq.org/a/<domain>/enterprise/api/v1/commcareversioncompliance/

API Usage

https://commcarehq.org/a/<domain>/enterprise/api/v1/apiusage/

Provide Credentials

If you have not previously specified credentials for the data source, PowerBI will prompt you to configure them. Use your Commcare HQ username, including email. For password, provide the the value of a current API key. If you want to use these credentials across domains, you can leave the specified level as “https://commcarehq.org”. Drilling-down will provide options to restrict which URLs will use these credentials

Load Data

If the credentials were specified correctly, a screen will be presented with a preview of the data. Click “Load” to load the data, or “Transform Data” to customize columns, modify data types, or perform other customizations prior to load.