Skip to content

README.md

Latest commit

 

History

History
53 lines (33 loc) · 5.29 KB

README.md

File metadata and controls

53 lines (33 loc) · 5.29 KB

Troubleshooting

Overview

Available Operations

post_api_index_v1_debug_datasource_document_events

Retrieves lifecycle events for a specific document including upload time, index times and deletions. Rate limited to 1 request per minute per datasource. Currently in beta, might undergo breaking changes without prior notice.

Example Usage

from glean.api_client import Glean
import os


with Glean(
    api_token=os.getenv("GLEAN_API_TOKEN", ""),
) as glean:

    res = glean.troubleshooting.post_api_index_v1_debug_datasource_document_events(datasource="<value>", object_type="Article", doc_id="art123", start_date="2025-05-01", max_events=50)

    # Handle response
    print(res)

Parameters

Parameter Type Required Description Example
datasource str ✔️ The datasource to which the document belongs
object_type str ✔️ Object type of the document to get lifecycle events for. Article
doc_id str ✔️ Glean Document ID within the datasource to get lifecycle events for. art123
start_date Optional[str] ➖ The start date for events to be fetched. Cannot be more than 30 days (default 7 days) in the past. 2025-05-01
max_events Optional[int] ➖ Max number of events to be fetched. Cannot be more than 100 (default 20). 50
retries Optional[utils.RetryConfig] ➖ Configuration to override the default retry behavior of the client.

Response

models.DebugDocumentLifecycleResponse

Errors

Error Type Status Code Content Type
errors.GleanError 4XX, 5XX */*