Getting the current Usage Reporting configuration

If the Usage Reporting configuration is not set, this endpoint will return a 404. Once the configuration is set, this endpoint will indicate whether the server will share usage data with the Central team. If the server will share usage data, and contact information was provided, this endpoint will also return the provided work email address and organization name.

get/v1/config/analytics

Response

keystring required

The type of system configuration.

setAtstring required

ISO date format. The last time this system configuration was set.

Example response

{
  "key": "analytics",
  "setAt": "2018-01-06T00:32:52.787Z",
  "value": {
    "enabled": true,
    "email": "my.email.address@getodk.org",
    "organization": "Organization Name"
  }
}

Changes

Changed in 4 of the 54 revisions of this API.713

Apr 3, 20262aed27d9e01353See the full diff
- ▲
  the response's body type/format changed from object/ to / for status 200
  response-body-type-changed
- ▲
  the code response's property type/format changed from string/ to number/ for status 404
  response-property-type-changed
- ▲
  removed the required property key from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property setAt from the response with the 200 status
  response-required-property-removed
- ▲
  removed the required property value from the response with the 200 status
  response-required-property-removed
- ○
  api tag System Configuration added
  api-tag-added
- ○
  api tag Usage Reporting Configuration removed
  api-tag-removed
- ○
  added Config subschema #2 to the response body allOf list for the response status 200
  response-body-all-of-added
Dec 20, 2025022694254f0d1See the full diff
- ○
  api operation id Getting the current configuration removed and replaced with getTheCurrentConfiguration
  api-operation-id-removed
Oct 27, 2025b11b54eea4871See the full diff
- ○
  removed the non-success response with the status 403
  response-non-success-status-removed
Mar 13, 2025e8c2858fd4eb28See the full diff
- ▲
  the response's body type/format changed from / to object/ for status 200
  response-body-type-changed
- ▲
  the code response's property type/format changed from number/ to string/ for status 404
  response-property-type-changed
- ○
  api operation id getTheCurrentConfiguration removed and replaced with Getting the current configuration
  api-operation-id-removed
- ○
  api tag Usage Reporting Configuration added
  api-tag-added
- ○
  api tag System Configuration removed
  api-tag-removed
- ○
  removed Config subschema #2 from the response body allOf list for the response status 200
  response-body-all-of-removed
- ○
  added the non-success response with the status 403
  response-non-success-status-added
- ○
  added the required property key to the response with the 200 status
  response-required-property-added
- ○
  added the required property setAt to the response with the 200 status
  response-required-property-added
- ○
  added the required property value to the response with the 200 status
  response-required-property-added
This revision also has 11 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history