System Configuration

Getting the current Usage Reporting configuration

Changed on

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

Request

  • Base URL
    / (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /v1/config/analytics
  • Auth
    none declared

Response

OK

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

  • 2aed27d9e013Revision changes
    • breaking

      the response's body type changed from object to no type for status

    • breaking

      the response's property type changed from string to number for status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • breaking

      removed the required property from the response with the status

    • info

      api tag System Configuration added

    • info

      api tag Usage Reporting Configuration removed

    • info

      added subschema #2 to the response body allOf list for the response status

  • 022694254f0dRevision changes
    • info

      api operation id Getting the current configuration removed and replaced with getTheCurrentConfiguration