Skip to main content

Get queue debug info

Enterprise

This endpoint is part of Countly Enterprise. To get access, contact sales or compare versions. Existing customers can reach the support portal with questions.

Endpoint

/o/content/debug

Overview

Returns user-friendly queue status details for one user.

Authentication

Pass api_key or auth_token as a query parameter, or send countly-token as a header. See Authentication.

Permissions

  • Required permission: Read on the content feature

Request Parameters

ParameterTypeRequiredDescription
api_keyStringYes (or auth_token)API key for authentication
auth_tokenStringYes (or api_key)Auth token for authentication
app_idStringYesApplication identifier
uidStringYesUser ID

Examples

Example 1: Check Queue Status for a User

/o/content/debug?api_key=YOUR_API_KEY&app_id=5be987d7b93798516eb5289a&uid=user_12345

Response

Success Response

{
"Queue Summary": {
"Total Items": 2,
"Last Content View": "2 hours ago",
"Cooldown Status": "Cooldown expired 2 hours ago",
"Content Available": "Yes"
},
"Next Available Content": {
"Content ID": "5d4472152de8f07336f3b352",
"Priority Level": 3,
"Category": "Uncategorized",
"Added to Queue": "5 minutes ago",
"Expires": "in 23 hours",
"Journey ID": "No Journey",
"Additional Metadata": {}
},
"All Queue Items": [
{
"Content ID": "5d4472152de8f07336f3b352",
"Priority Level": 3,
"Category": "Uncategorized",
"Added to Queue": "5 minutes ago",
"Expires": "in 23 hours",
"Journey ID": "No Journey",
"Additional Metadata": {}
}
]
}

Response Fields

FieldTypeDescription
Queue SummaryObjectQueue overview
Queue Summary.Total ItemsNumberNumber of non-expired queue items (max 20 listed)
Queue Summary.Last Content ViewStringRelative time string
Queue Summary.Cooldown StatusStringCooldown state description
Queue Summary.Content AvailableStringContent availability summary
Next Available ContentObject/StringNext deliverable item details, or a cooldown/empty state string
All Queue ItemsArrayList of queue entries with friendly fields
Queue StatusStringReturned when queue is empty

Error Responses

HTTP StatusResponse
500"Error"

Behavior

  1. Builds EngagementQueue for app_id + uid.
  2. Reads user state and up to 20 non-expired queue entries.
  3. Computes cooldown text and availability summary.
  4. Returns a user-friendly debug object.
Implementation details

Database Collections

CollectionUsed forData touched by this endpoint
countly.content_queueEndpoint data source** - Queue entries
countly.app_users{app_id}Endpoint data source** - User content state (content.last_view_ts, content.state_update_ts)
countly.appsEndpoint data source** - App plugin cooldown configuration lookup