Report document activity

post/activity

Report user activity that occurs on indexed documents such as viewing or editing. This signal improves search quality.

SecurityBearerAuth

Request

Request Body schema: application/json
required

required

Array of objects (ActivityEvent)

Responses

200

400

Invalid request

401

Not Authorized

429

Too Many Requests

Request samples

Payload
curl

application/json

{"events": [{"url": "https://example.com/",
"action": "HISTORICAL_VIEW",
"timestamp": "2000-01-23T04:56:07.000Z"
},
{"url": "https://example.com/search?q=query",
"action": "SEARCH",
"timestamp": "2000-01-23T04:56:07.000Z",
"params": {"query": "query"
}
},
{"url": "https://example.com/",
"action": "VIEW",
"timestamp": "2000-01-23T04:56:07.000Z",
"params": {"duration": 20,
"referrer": "https://example.com/document"
}
}
]
}

Report document activity

Request Body schema: application/jsonrequired

Request Body schema: application/json
required