Troubleshooting

Beta: Get document information

Changed on

Gives various information that would help in debugging related to a particular document. Currently in beta, might undergo breaking changes without prior notice.

Tip: Refer to the Troubleshooting tutorial for more information.

post/api/index/v1/debug/{datasource}/document

Request

  • Base URL: https://instance-name-be.glean.com
  • URL: https://instance-name-be.glean.com/api/index/v1/debug/{datasource}/document
  • Auth: HTTP bearer

Path parameters

datasourcestring required

The datasource to which the document belongs

Request body

objectTypestring required

Object type of the document to get the status for.

docIdstring required

Glean Document ID within the datasource to get the status for.

Example request

{
  "objectType": "Article",
  "docId": "art123"
}

Response

OK

Example response

{
  "status": {
    "uploadStatus": "UPLOADED",
    "lastUploadedAt": "2021-08-06T17:58:01.000Z",
    "indexingStatus": "INDEXED",
    "lastIndexedAt": "2021-08-06T17:58:01.000Z",
    "permissionIdentityStatus": "UPLOADED"
  }
}

Changes

  • ccd209790de5Revision changes
    • info

      media type application/json; charset=UTF-8 was changed to application/json for the response status