This guide explains how to retrieve streaming session analytics using Eagle’s Analytics API. Use this API to:
-
Monitor overall streaming activity
-
View session-level details (users, devices, regions, etc.)
-
Track usage trends over a selected date range
Endpoint
POST https://agw.eaglepixelstreaming.com/api/v4/fb/user-data-by-range
Request Body
Send a JSON object in the following format:
{
"start": "YYYY-MM-DD",
"end": "YYYY-MM-DD",
"apiKey": "YOUR_PERSONAL_API_KEY",
"uid": "YOUR_ASSIGNED_UID"
}
Parameter Details:
-
start : The start date of the range (format: YYYY-MM-DD)
-
end : The end date of the range (format: YYYY-MM-DD)
-
apiKey : Your personal API key. Retrieve your API key
-
uid: Your unique user identifier. To receive your UID, please contact the Eagle Support Team
Example Request
{
"start": "2025-04-01",
"end": "2025-04-10",
"apiKey": "abc123xyz456",
"uid": "btl6CxobgXRgrbiednegoin2289357gdfkKJBFB"
}
Response
The API will return a list of all streaming sessions within the date range across all your apps. Each session will include:
-
appName : Name of the streamed app
-
appVersion : Version of the app
-
city : User’s city
-
country : User’s country
-
videoStartTime : Timestamp when the stream started
-
videoStopTime : Timestamp when the stream ended
-
device : User’s device (e.g., iPhone, Android, PC)
-
browser : Browser used during the session
-
os : Operating system of the device
-
streamTime : Total duration of the stream (in seconds)
Notes
-
The API currently does not support filtering by a specific app in the request. You'll need to filter the data manually based on the
appNamefield from the response. -
There are rate limits on how often you can call the API.
-
If you need help with your API key, see this guide:
Retrieve API Key -
Monitor your streaming usage through the Analytics section in the Control Panel.
Swagger API Reference
You can explore and test the API using our Swagger UI:
https://agw.eaglepixelstreaming.com/api-docs/
Limitations
Please read the following carefully before building anything on top of this API:
-
Not intended for real-time dashboards: This API is not designed to power live or real-time dashboards. Rate limits are intentionally in place to prevent high-frequency polling. Building a real-time dashboard on top of this API is not a supported use case.
-
Each request is resource-intensive: Every API call involves significant processing on Eagle's infrastructure. Please be mindful of call frequency and avoid unnecessary or automated repeated requests.
-
Data has a delay of 30 seconds to 1 minute: There is a delay between an actual streaming event occurring and it appearing in the API response. Do not rely on this API for instant or up-to-the-second accuracy.
-
No app-level filtering in the request: The API returns data across all your apps for the given date range. Filtering by a specific appName must be done manually on your end after receiving the response.
Recommendation
For the most accurate and up-to-date view of your streaming activity, use the monitoring tools available directly in your Control Panel Analytics at https://controlpanel.eagle3dstreaming.com/analytics
Need help?
If you need any assistance, feel free to reach out through any of the following channels:
🛠️ Support Portal: Contact Our Support Team
💬 Discord Community (Faster Support): Join Our Discord Community
📧 Email Support: support@eagle3dstreaming.com
Follow us on: