rodrigo/iachat
1
0
Fork 0
Code Issues Pull Requests Actions 3 Packages Projects Releases Wiki Activity
e9e6de5690
iachat/swagger/definitions/resource
History
Pranav 329b749702
Add API documentation for inbox, agent, and team summary report (#13409) 
- Add API documentation for inbox, agent, and team summary report
endpoints
- These endpoints return conversation statistics grouped by
inbox/agent/team for a given date range

Endpoints documented:
GET /api/v2/accounts/{account_id}/summary_reports/inbox │ Conversation
stats grouped by inbox │
GET /api/v2/accounts/{account_id}/summary_reports/agent │ Conversation
stats grouped by agent │
GET /api/v2/accounts/{account_id}/summary_reports/team │ Conversation
stats grouped by team │

Query parameters (all endpoints):
- since - Start timestamp (Unix)
- until - End timestamp (Unix)
- business_hours - Calculate metrics using business hours only

Response fields:
- id - Inbox/Agent/Team ID
- conversations_count - Total conversations in date range
- resolved_conversations_count - Resolved conversations in date range
- avg_resolution_time - Average resolution time (seconds)
- avg_first_response_time - Average first response time (seconds)
- avg_reply_time - Average reply time (seconds)
2026-01-30 22:48:10 +04:00
..
extension feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
integrations Fix: Make swagger doc compliant to OpenAPI (#3394) 2021-11-17 18:55:15 +05:30
public feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374) 2025-05-22 14:26:44 +07:00
reports Add API documentation for inbox, agent, and team summary report (#13409) 2026-01-30 22:48:10 +04:00
account_detail.yml docs: add swagger spec for accounts API (#11620) 2025-05-29 11:23:27 +05:30
account_show_response.yml docs: add swagger spec for accounts API (#11620) 2025-05-29 11:23:27 +05:30
account_user.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374) 2025-05-22 14:26:44 +07:00
account.yml chore: Update API docs (#1153) 2020-08-18 12:14:37 +05:30
agent_bot.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
agent.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
article.yml fix: Help center api doc (#7189) 2023-05-25 18:50:00 +05:30
audit_log.yml chore: add audit-logs swagger (#12001) 2025-07-22 13:42:31 +04:00
automation_rule_item.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
automation_rule.yml feat: Add automation rule event conversation resolved (#9669) 2025-08-13 12:57:14 +05:30
canned_response.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
category.yml fix: Help center api doc (#7189) 2023-05-25 18:50:00 +05:30
contact_conversation_message.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contact_conversations_response.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contact_detail.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contact_inbox.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contact_inboxes.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contact_list_item.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contact_meta.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contact_show_response.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contact.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contactable_inboxes_response.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
contactable_inboxes.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11374) 2025-05-22 14:26:44 +07:00
contacts_list_response.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
conversation_messages.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
conversation_meta.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
conversation.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
custom_attribute.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
custom_filter.yml Fix: Make swagger doc compliant to OpenAPI (#3394) 2021-11-17 18:55:15 +05:30
inbox_contact.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
inbox.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
message_detailed.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
message.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
platform_account.yml chore: Add Swagger docs for Platform APIs (#2349) 2021-05-31 10:58:43 +05:30
portal_config.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
portal_item.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
portal_logo.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
portal_meta.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
portal_single.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
portal.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
reporting_event_meta.yml feat: allow querying reporting events via the API (#12832) 2025-11-13 12:46:55 +05:30
reporting_event.yml feat: allow querying reporting events via the API (#12832) 2025-11-13 12:46:55 +05:30
reporting_events_list_response.yml feat: allow querying reporting events via the API (#12832) 2025-11-13 12:46:55 +05:30
team.yml docs: Add documentation for integration APIs (#2300) 2021-05-20 20:46:45 +05:30
user.yml feat: Update swagger to openapi 3.0.4, update request payloads with examples (#11533) 2025-05-22 17:57:12 +07:00
webhook.yml feat(webhooks): add name to webhook (#12641) 2025-11-13 13:28:15 +05:30