Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mohakcodes/boni-agent-api
The boni-agent-api is designed to manage agents and track their associated calls. The API has two main sections: agent and calls, each with CRUD and analytical endpoints to handle data operations.
https://github.com/mohakcodes/boni-agent-api
javascript mongodb mongoose nodejs
Last synced: 14 days ago
JSON representation
The boni-agent-api is designed to manage agents and track their associated calls. The API has two main sections: agent and calls, each with CRUD and analytical endpoints to handle data operations.
- Host: GitHub
- URL: https://github.com/mohakcodes/boni-agent-api
- Owner: mohakcodes
- Created: 2024-10-29T21:53:21.000Z (19 days ago)
- Default Branch: main
- Last Pushed: 2024-10-30T00:03:24.000Z (18 days ago)
- Last Synced: 2024-10-30T00:43:27.275Z (18 days ago)
- Topics: javascript, mongodb, mongoose, nodejs
- Language: JavaScript
- Homepage: https://boni-agent-api.onrender.com/
- Size: 24.4 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# API Overview
The boni-agent-api is designed to manage agents and track their associated calls. The API has two main sections: agent and calls, each with CRUD and analytical endpoints to handle data operations.
# Main Testing Endpoint
GET `/calls/stats/from`
Purpose: Retrieves call records within a specified time range, showing `totalcalls`, `connectedCalls` and `notConnectedCalls`.
Query Parameters:
- `startTime` (required): The starting point of the time range (UNIX timestamp, 10 digits).
- `endTime` (required): The ending point of the time range (UNIX timestamp, 10 digits).
- `agentId` (optional): When provided, fetches statistics specifically for the agent with this ID.
# Some Example Requests
GET: `https://boni-agent-api.onrender.com/calls/stats/from?startTime=1600000000&endTime=1735000000`
#### Example Response:
```json
[
{
"agent": {
"_id": "6721209b1a063fa6c037c827",
"name": "Agent2",
"email": "[email protected]"
},
"totalCalls": 2,
"connectedCalls": 1,
"notConnectedCalls": 1
},
{
"agent": {
"_id": "672120a61a063fa6c037c82b",
"name": "Agent3",
"email": "[email protected]"
},
"totalCalls": 3,
"connectedCalls": 2,
"notConnectedCalls": 1
}
]
```
GET: `https://boni-agent-api.onrender.com/calls/stats/from?startTime=1600000000&endTime=1735000000&agentId=6721209b1a063fa6c037c827`
#### Example Response:
```json
{
"agent": {
"_id": "6721209b1a063fa6c037c827",
"name": "Agent2",
"email": "[email protected]"
},
"totalCalls": 2,
"connectedCalls": 1,
"notConnectedCalls": 1
}
```
# All Agent Endpoints
- GET `/agent` - Retrieve all agents.
- GET `/agent/:id` - Retrieve a specific agent by ID.
- POST `/agent` - Create a new agent.
- PUT `/agent/:id` - Update agent information by ID.
- DELETE `/agent/:id` - Delete an agent by ID.
# All Call Endpoints
- GET `/calls` - Retrieve all call records.
- GET `/calls/:id` - Retrieve a specific call by ID.
- POST `/calls` - Log a new call.
- GET `/calls/agent/:agentId` - Retrieve all calls associated with a specific agent.
- GET `/calls/stats/from` - Fetches call records for the given "startTime to endTime" timestamps in "UNIX" format (10 digits) along with connected / not connected details.