This article reviews helpful debug endpoints you can use to investigate indexing API issues. For a comprehensive document on the different endpoints available for debugging please review this troubleshooting document. If you require further assistance debugging, the Next Steps section describes what information to share with Super Support when raising a ticket.
Debug Data source Status
Documentation Link
Request sample:
curl -i -X POST \ 'https://domain-be.glean.com/api/index/v1/debug/{datasource}/status' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>'
When to use:
If you want don't know whether your indexing job was successful or not you can use this endpoint to confirm if your documents have been uploaded and indexed. The bulkUploadHistory will show the details of your document indexing endpoint time. After documents are uploaded, they will be queued for processing. New documents will be available in search results when the processingHistory timestamp is after the bulkUploadHistory.
Debug Data source Document
Documentation Link
Request sample:
curl -i -X POST \ 'https://domain-be.glean.com/api/index/v1/debug/{datasource}/document' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json; charset=UTF-8' \ -d '{ "objectType": "Article", "docId": "art123" }'
When to use:
If a user reports a missing document, this endpoint can be used to confirm if a document is present in the data source index and verify what permissions this document has. A user will be able to view a document if any of the below criteria is met:
- allowAnonymousAccess is true
- allowAllDatasourceUsersAccess is true and user has been indexed as a user of the data source
- user is a member of the allowedGroups and in the list of allowedUsers OR allowedGroupIntersections
Debug Data source User
Documentation Link
Request sample:
curl -i -X POST \ 'https://domain-be.glean.com/api/index/v1/debug/{datasource}/user' \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json; charset=UTF-8' \ -d '{ "email": "u1@foo.com" }'
When to use:
This endpoint can be used along with debug data source document to confirm if a user is in the group(s) provisioned to have access to the document.
Check Document Access
Documentation Link
Request sample:
curl -i -X POST \ https://domain-be.glean.com/api/index/v1/checkdocumentaccess \ -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \ -H 'Content-Type: application/json' \ -d '{ "datasource": "string", "objectType": "string", "docId": "string", "userEmail": "string" }'
When to use:
To check if a user has access to view a document in Super. The response will show true or false. If false, review the debug endpoints debug data source user and debug data source document to check
Next Steps
Reach out to Support! If you need help debugging your issue please contact Support and provide the following details.
- Description of the issue including error message
- Endpoint url and request body schema
- Data source name
- Timestamp/timezone of when you encountered the error