SDK - SDK Logs Stop
Endpoint
/i/sdk_logs/stop
Overview
Stops SDK log gathering for one app user. Logs already gathered are kept.
Authentication
Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.
Permissions
Requires sdk Update permission.
Request Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
api_key | String | Conditional | Required if auth_token is not provided. |
auth_token | String | Conditional | Required if api_key is not provided. |
app_id | String | Yes | App id. |
uid | String | Yes | Countly internal user ID. |
Examples
Stop gathering
/i/sdk_logs/stop?api_key=YOUR_API_KEY&app_id=6991c75b024cb89cdc04efd2&uid=1
Response
Success Response
{
"result": "Success"
}
Response Fields
| Field | Type | Description |
|---|---|---|
result | String | Success when gathering is marked as stopped. |
Error Responses
400
{
"result": "Missing parameter \"app_id\""
}
400
{
"result": "Error: ..."
}
404
{
"result": "No SDK log gathering state for this user"
}
500
{
"result": "Error stopping SDK log gathering"
}
Behavior
- Marks the user's gathering state as stopped and records the stop time.
- Gathered logs and counters are kept.
Impact on Other Data
- Updates the user's document in
countly.app_users{appId}.