Setting new configuration for Usage Reporting
Changed onAn 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.
Request
- Base URL/ (relative, and the document was published on a file host, not at the API’s origin)
- URL/v1/config/analytics
- Authnone declared
Request body */*
Example request
{
"enabled": true,
"email": "my.email.address@getodk.org",
"organization": "Organization Name"
}Response
OK
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
objectto 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 Configurationadded - info
api tag
Usage Reporting Configurationremoved - info
added
subschema #2to the response bodyallOflist for the response status
- breaking
- info
api operation id
Setting a new configurationremoved and replaced withsetConfiguration
- info