System Configuration

Setting new configuration for Usage Reporting

Changed on

An Administrator can use this endpoint to choose whether the server will share anonymous usage data with the Central team. This configuration affects the entire server. Until the Usage Reporting configuration is set, Administrators will see a message on the Central administration website that provides further information.

If an Administrator specifies true for enabled, the server will share anonymous usage data monthly with the Central team. By specifying true, the Administrator accepts the Terms of Service and Privacy Policy. The Administrator can also share contact information to include with the report.

If an Administrator specifies false for enabled, the server will not share anonymous usage data with the Central team. Administrators will no longer see the message on the administration website.

If the Usage Reporting configuration is already set, the current configuration will be overwritten with the new one.

post/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

Request body */*

enabledboolean required

true if the server will share usage data with the Central team and false if not.

emailstring

The work email address to include with the metrics report.

organizationstring

The organization name to include with the metrics report.

Example request

{
  "enabled": true,
  "email": "my.email.address@getodk.org",
  "organization": "Organization Name"
}

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

    • breaking

      the response's body type changed from object to no type 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

    • info

      api operation id Setting a new configuration removed and replaced with setConfiguration