Statistics

Returns a statistic from the system by its ID.

This method will look up a statistic by the specified ID and return it back.

Request

Security:

path Parameters

tenantId required	string The id of the tenant being accessed.
id required	string The ID of the statistic to return.

query Parameters

parameters	string Parameters to the query
recalculate	boolean If true, the latest statistic will be calculated and the cache will be updated

Responses

200The statistic was retrieved successfully.

400The request was not valid.

401Unauthorized.

403Forbidden.

404The statistic could not be found.

429Limit exceeded... unable to retrieve statistic based on tenant limits.

500General server error.

get/statistics/{tenantId}/{id}

Request samples

curl
JavaScript
C#
PHP
Python

curl -i -X GET \
  'https://membership.api.rhythmsoftware.com/statistics/:tenantId/:id?parameters=string&recalculate=true' \
  -H 'Authorization: YOUR_API_KEY_HERE'

Response samples

application/json

{"id": "string",
"name": "string",
"error": "string",
"value_for_previous_period": 0,
"value_difference_numeric": 0,
"value_difference_percentage": 0,
"values": [{ }
],
"status": "valid",
"value": 0,
"sys_deleted_by_id": "string",
"sys_version": 0,
"sys_created_at": "2019-08-24T14:15:22Z",
"sys_last_modified_at": "2019-08-24T14:15:22Z",
"sys_created_by_id": "string",
"sys_last_modified_by_id": "string",
"sys_external_id": "string",
"sys_locked": true,
"sys_bulk_load_pk": "string",
"sys_bulk_load_at": "string",
"sys_bulk_load_id": "string",
"sys_bulk_load_record_no": 0,
"sys_bulk_load_source_file": "string",
"sys_directive": "string",
"sys_snapshot_base_version": 0,
"sys_configuration_snapshot_id": "string"
}