curl --request POST \
  --url https://{domain}-be.glean.com/api/index/v1/debug/{datasource}/documents \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json; charset=UTF-8' \
  --data '{
  "debugDocuments": [
    {
      "objectType": "Article",
      "docId": "art123"
    }
  ]
}'
{
  "documentStatuses": [
    {
      "docId": "<string>",
      "objectType": "<string>",
      "debugInfo": {
        "status": {
          "uploadStatus": "UPLOADED",
          "lastUploadedAt": "2021-08-06T17:58:01.000Z",
          "indexingStatus": "INDEXED",
          "lastIndexedAt": "2021-08-06T17:58:01.000Z",
          "permissionIdentityStatus": "UPLOADED"
        },
        "uploadedPermissions": {
          "allowedUsers": [
            {
              "email": "<string>",
              "datasourceUserId": "<string>",
              "name": "<string>"
            }
          ],
          "allowedGroups": [
            "<string>"
          ],
          "allowedGroupIntersections": [
            {
              "requiredGroups": [
                "<string>"
              ]
            }
          ],
          "allowAnonymousAccess": true,
          "allowAllDatasourceUsersAccess": true
        }
      }
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
datasource
string
required

The datasource to which the document belongs

Body

application/json; charset=UTF-8

Describes the request body of the /debug/{datasource}/documents API call.

​
debugDocuments
object[]
required

Documents to fetch debug information for

Describes the request body of the /debug/{datasource}/document API call.

Response

200
application/json; charset=UTF-8
OK

Describes the response body of a single document in the /debug/{datasource}/documents API call

​
documentStatuses
object[]

List of document ids/urls and their debug information

Describes the response body of a single document in the /debug/{datasource}/documents API call

Was this page helpful?

Suggest editsRaise issue