StatisticsResource
A REST Web Service for managing Statistics and Stats Definitions.
The following resources are applicable:
- /statistics/definitions/{csId}
- /statistics/definitions/{csId}/{id}
- /statistics/definitions/{csId}/{refId}
- /statistics/definitions/{csId}/name/{name}
- /statistics/records
- /statistics/records/{csId}/id/{refId}
- /statistics/records/interval/{start}/{end}
- /statistics/records/interval/{start}/{end}/{domain}
- /statistics/records/name/{name}
/statistics/definitions/{csId}
Mount Point: /statistics/definitions/{csId}
GET
Retrieves all statistics definitions for a given change set. The reported ID of a statistic definition is the reference ID (the concept id in the sdc_statistic_ref table) not the actual definition ID (the id in the sdc_statistic_defn table).
Parameters
| name | description | type | default |
|---|---|---|---|
| csId | The change set ID | path |
Response Body
| element: | statisticDefinitions |
| media types: | application/xml text/xml application/json |
An Statistics object containing all the statistics definitions
POST
Creates a new Statistic Definition.
Parameters
| name | description | type | default |
|---|---|---|---|
| csId | The change set ID | path |
Request Body
| element: | statisticDefinition |
| media types: | application/xml text/xml application/json |
The definition
Response Body
| element: | statisticDefinition |
| media types: | application/xml text/xml application/json |
The newly updated definition
/statistics/definitions/{csId}/{id}
Mount Point: /statistics/definitions/{csId}/{id}
PUT
Updates a Statistic Definition.
Parameters
| name | description | type | default |
|---|---|---|---|
| id | The reference ID (the concept_id in the sdc_statistic_ref table) for the definition to change | path | |
| csId | The change set ID | path |
Request Body
| element: | statisticDefinition |
| media types: | application/xml text/xml application/json |
The definition
Response Body
| element: | statisticDefinition |
| media types: | application/xml text/xml application/json |
The newly updated definition
/statistics/definitions/{csId}/{refId}
Mount Point: /statistics/definitions/{csId}/{refId}
GET
Retrieves a single statistics definition for a given change set.
Parameters
| name | description | type | default |
|---|---|---|---|
| csId | The change set ID | path | |
| refId | The reference ID (the concept_id in the sdc_statistic_ref table) for the definition | path |
Response Body
| element: | statisticDefinition |
| media types: | application/xml text/xml application/json |
A Statistics object containing all the statistics definitions
DELETE
Deletes a Statistics Definition.
Parameters
| name | description | type | default |
|---|---|---|---|
| refId | The reference ID (the concept_id in the sdc_statistic_ref table) for the definition | path | |
| csId | The change set ID | path |
Response Body
| element: | (custom) |
| media types: | application/xml text/xml application/json |
200 on success, 404 on error
/statistics/definitions/{csId}/name/{name}
Mount Point: /statistics/definitions/{csId}/name/{name}
GET
Retrieves a single statistics definition for a given name and change set.
Parameters
| name | description | type | default |
|---|---|---|---|
| csId | The change set ID | path | |
| name | The name for the definition | path |
Response Body
| element: | statisticDefinition |
| media types: | application/xml text/xml application/json |
A Statistics object containing the statistics definition
/statistics/records
Mount Point: /statistics/records
GET
Retrieves all statistics records.
Response Body
| element: | statistics |
| media types: | application/xml text/xml application/json |
an Statistics object containing all the relevant stats
/statistics/records/{csId}/id/{refId}
Mount Point: /statistics/records/{csId}/id/{refId}
GET
Retrieves all statistics records matching a reference id.
Parameters
| name | description | type | default |
|---|---|---|---|
| csId | The change set ID | path | |
| refId | The reference ID (the concept_id in the sdc_statistic_ref table) for the definition | path |
Response Body
| element: | statistics |
| media types: | application/xml text/xml application/json |
A Statistics object containing all the relevant stats
/statistics/records/interval/{start}/{end}
Mount Point: /statistics/records/interval/{start}/{end}
GET
Retrieves all statistics records started in a given interval.
Parameters
| name | description | type | default |
|---|---|---|---|
| start | The start time of the interval | path | |
| end | The end time of the interval | path |
Response Body
| element: | statistics |
| media types: | application/xml text/xml application/json |
A Statistics object containing all the relevant stats
/statistics/records/interval/{start}/{end}/{domain}
Mount Point: /statistics/records/interval/{start}/{end}/{domain}
GET
Retrieves all statistics records started in a given interval.
Parameters
| name | description | type | default |
|---|---|---|---|
| start | The start time of the interval | path | |
| end | The end time of the interval | path | |
| domain | The domain to filter on | path |
Response Body
| element: | statistics |
| media types: | application/xml text/xml application/json |
A Statistics object containing all the relevant stats
/statistics/records/name/{name}
Mount Point: /statistics/records/name/{name}
GET
Retrieves all statistics records of a given name.
Parameters
| name | description | type | default |
|---|---|---|---|
| name | The definition name for the stats | path |
Response Body
| element: | statistics |
| media types: | application/xml text/xml application/json |
A Statistics object containing all the relevant stats