Checking repository statistics via REST

This page explains how to build and send a HTTP request to the Repository API that returns repository statistics.

Requirement

• Running D1 instance
• Session ID obtained from authentication
• Repository ID following the syntax adx.repository.[REPOSITORY_NAME], as in adx.repository.myrepository

cURL example

Copy the example below and adapt the following parameters for a quick test:

• [D1_HOST] — Replace with your D1 host name.
• [SESSION_ID] — Replace with the session ID.
• [REPOSITORY_ID] — Replace with the repository ID.

curl --location --request GET '[D1_HOST]/tribefire-services/api/v1/access.adx.admin/v1/repository/statistics?sessionId=[SESSION_ID]&repositoryId=[REPOSITORY_ID]'

Endpoint description

Request type	Endpoint	Service description	Request query parameters	Form data	Returns
GET	[D1_HOST]/tribefire-services/api/v1/access.adx.admin/v1/repository/statistics	Get repository statistics.	sessionId, repositoryId	None	Repository statistics data from content and cache storage.

Response message

The response includes comprehensive statistical data about documents in both content (contentStatistics entries) and cache (cacheStatistics entries) areas of a repository.

{
    "_type": "tribefire.adx.model.deployment.service.statistics.GetRepositoryStatisticsResponse",
    "_id": "0",
    "cacheStatistics": {
        "_type": "tribefire.adx.model.deployment.service.statistics.CacheStatistics",
        "_id": "1",
        "numberOfDocuments": 8,
        "numberOfPages": 20,
        "numberOfRepresentations": 28,
        "numberOfSourceRepresentations": 8,
        "representationsAverageSize": 130329.25,
        "representationsMaxSize": 1604129,
        "representationsMinSize": 966,
        "representationsSize": 3649219,
        "representationsStatus": {
            "_type": "flatmap",
            "value": [
                "created",
                8
            ]
        },
        "sourceRepresentationsAverageSize": 115814.875,
        "sourceRepresentationsMaxSize": 247321,
        "sourceRepresentationsMinSize": 15815,
        "sourceRepresentationsSize": 926519
    },
    "contentStatistics": {
        "_type": "tribefire.adx.model.deployment.service.statistics.ContentStatistics",
        "_id": "2",
        "averageSize": 84487.66666666667,
        "lastModifiedAt": "2020-09-29T12:06:26.356+0200",
        "lastModifiedBy": "grzegorz",
        "maxSize": 222700,
        "minSize": 15815,
        "numberOfActiveContents": 4,
        "numberOfActiveFolders": 2,
        "numberOfContents": 6,
        "numberOfDeactivatedContents": 2,
        "numberOfDeactivatedFolders": 2,
        "numberOfFolders": 4,
        "size": 506926,
        "sizeDistribution": {
            "_type": "tribefire.adx.model.deployment.service.statistics.SizeDistribution",
            "_id": "3",
            "residuals": 0,
            "size_0_1MB": 6,
            "size_100MB_1GB": 0,
            "size_10MB_100MB": 0,
            "size_1GB_10GB": 0,
            "size_1MB_10MB": 0
        }
    },
    "createdAt": "2020-09-28T17:46:09.758+0200",
    "createdBy": "grzegorz",
    "duration": 58,
    "executionDate": "2020-09-30T16:25:55.554+0200",
    "modifiedAt": "2020-09-28T17:46:09.758+0200",
    "modifiedBy": "grzegorz",
    "name": "new",
    "notifications": [
        {
            "_type": "com.braintribe.model.notification.CommandNotification",
            "_id": "4",
            "command": {
                "_type": "com.braintribe.model.uicommand.GotoModelPath",
                "_id": "5",
                "addToCurrentView": true,
                "name": "Repository Statistics",
                "path": {
                    "_type": "com.braintribe.model.path.GmModelPath",
                    "_id": "6"
                },
                "showFullModelPath": true
            },
            "executeManually": false
        }
    ],
    "repositoryTechnicalName": "new",
    "type": "STANDARD"
}

OpenAPI

For a code sample, see

Get repository statistics by ID