Get Catalog Service statistics

get/statistics
Internal-Use Only

Return information about the contents of the catalog, such as:

  • the defined search indices,
  • how many documents are in each index, and possibly
  • a message about needing to rebuild the index if it has fallen out of sync.

Request Samples

1

Response Samples

1{
2  "version": 1,
3  "searchIndexStats": {
4    "dataflows": {
5      "id": "ad8f2ca4-55fa-4e87-a05e-2e6e7a3cd020",
6      "nDocuments": 1
7    },
8    "datasets": {
9      "id": "f2351f74-09cb-4fc2-96df-6131946c354b",
10      "nDocuments": 180,
11      "breakdown": {
12        "field": "sourceSystem",
13        "values": {
14          "cas": 90,
15          "sas": 90
16        }
17      }
18    }
19  },
20  "links": [
21    {
22      "method": "GET",
23      "rel": "up",
24      "href": "/catalog",
25      "uri": "/catalog",
26      "type": "application/vnd.sas.api"
27    }
28  ]
29}

Header Parameters

NameTypeRequiredDescription
Accept
string
false

The desired item representation.

Allowed values:
application/vnd.sas.metadata.catalog.statistics+jsonapplication/json
Default:
application/vnd.sas.metadata.catalog.statistics+json

Responses

StatusMeaningDescription
200OKOK.HeadersSchema
401UnauthorizedNot authenticated.Schema
403ForbiddenThe user does not have permission to complete this request.Schema
404Not FoundThe Catalog service is not available.Schema
406Not AcceptableNot Acceptable. Include an Accept header with a supported value on the request.Schema