Skip to main content Skip to complementary content

Get statistics about journal

Gets the number of creation and update journal events during a period of time for each entity in a container, grouped first by the entity and then by the operation.
Request
GET /services/rest/system/stats/journal/{container}
Parameters
  • container: This is a String value which represents the name of the container.
  • lang (optional): This is a String value of the language code which specifies the language in which the label of each entity will be returned, for example, en for English. If this parameter is not specified or the label in the specified language does not exist, the name of the entity will be returned.
  • timeframe (optional): This is an integer value which limits the statistic data to the calls executed in the last N seconds.
  • top (optional): This is an integer value which limits the statistics data to the top N entities with most frequent updates. If the value is greater than 0, the statistics for the entities without any journal event will not be returned.
Headers
  • Accept: application/json
  • Authorization: Basic Authentication scheme
Response

A JSON response that contains statistics about creation and update journal events for each entity in the specified container.

Note that the object from and to represented as epoch time in the JSON response give a period of time and the object create and update give the number of creation and update journal events that happen during the time period.

Status
  • 200 OK: The operation is executed successfully.
  • 204 QUERY FAILS: Missing configuration information.
  • 401 UNAUTHORIZED: Login fails, invalid username or password.
  • 404 NO CONTENT: The request contains invalid parameter.
  • 500 INTERNAL SERVER ERROR: Other errors.

Sample response

{
    "journal": [
        {
            "Product": [
                {
                    "creations": [
                        {
                            "create": 1,
                            "from": 1548143636461,
                            "to": 1548143636461
                        }
                    ]
                },
                {
                    "updates": [
                        {
                            "update": 2,
                            "from": 1548143639124,
                            "to": 1548143685771
                        },
                        {
                            "update": 1,
                            "from": 1548143825716,
                            "to": 1548143872363
                        }
                    ]
                }
            ]
        },
        {
            "ProductFamily": [
                {
                    "creations": [
                        {
                            "create": 1,
                            "from": 1548142670616,
                            "to": 1548142670616
                        }
                    ]
                },
                {
                    "updates": []
                }
            ]
        },
        {
            "Store": [
                {
                    "creations": [
                        {
                            "create": 1,
                            "from": 1548142762672,
                            "to": 1548142772475
                        }
                    ]
                },
                {
                    "updates": []
                }
            ]
        }
    ]
}

Did this page help you?

If you find any issues with this page or its content – a typo, a missing step, or a technical error – please let us know!