Use the Eagle Pixel Streaming Analytics API

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/v3/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 appName field 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/

💬 Ask questions and help your peers Community Forum

📄 Need help? Contact Support

Facebook | GitHub | LinkedIn | YouTube