Get Interaction Summary

Staging Env

https://staging-api.formi.co.in

GET

/v2/interactions/summary

Last modified:2025-07-11 17:37:20

Maintainer:Not configured

Retrieves a summary of user interactions for a specific outlet over a given time period.
Authentication is required via a token in the token header. The outlet_id is automatically determined from this token.

Request

Query Params

Header Params

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET 'https://staging-api.formi.co.in/v2/interactions/summary?aggregation_timeline' \
--header 'token;'

Responses

🟢200OK

application/json

Interaction summary fetched successfully.

Body

Example

{
    "success": true,
    "message": "Interaction summary fetched successfully",
    "payload": {
        "cards": [
            {
                "key": "total_interactions",
                "value": 88
            },
            {
                "key": "total_outcomes",
                "value": 47
            },
            {
                "key": "total_escalations",
                "value": 0
            },
            {
                "key": "total_resolved_escalations",
                "value": 0
            }
        ],
        "aggregation_timeline": "last_week",
        "agent_name": "Infinity Learn"
    }
}

🟠401Unauthorized

🔴500Server Error

Modified at 2025-07-11 17:37:20

Set Email Configuration

Resolve an Escalated Interaction