Versions Compared

Old Version 2

changes.mady.by.user Matt Riley

Saved on

compared with

New Version Current

changes.mady.by.user Jing Cheng

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Add api doc for CommCareVersionCompliance, 2fa, api enterprise report.

...

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

...