---
agentTools:
  projectIndex: https://coviu.readme.io/llms.txt
---

# Get Session Summary

Here is some further information on the timestamps provided in the response:

- Start time - Scheduled start time for the session
- End time - Scheduled end time for the session
- Actual start time - Creation time of the call, typically when host has joined
- Actual end time - Call recorded as complete, last participant has left
- Participant entry time - Earliest recorded entry time for the participant, does not include time in Waiting Room
- Participant exit time - Latest recorded exit time for the participant.

# OpenAPI definition

```json
{
  "openapi": "3.0.0",
  "info": {
    "title": "Coviu REST API",
    "version": "1.0"
  },
  "servers": [
    {
      "url": "https://api.coviu.com"
    }
  ],
  "security": [
    {
      "ClientCredentials": []
    }
  ],
  "components": {
    "securitySchemes": {
      "ClientCredentials": {
        "type": "oauth2",
        "flows": {
          "clientCredentials": {
            "tokenUrl": "/v1/auth/token",
            "scopes": {}
          }
        }
      }
    },
    "schemas": {
      "Role": {
        "type": "string",
        "enum": [
          "GUEST",
          "HOST",
          "PARTICIPANT"
        ]
      },
      "ParticipantSummary": {
        "type": "object",
        "properties": {
          "participant_id": {
            "type": "string",
            "format": "uuid"
          },
          "role": {
            "$ref": "#/components/schemas/Role"
          },
          "entry_time": {
            "type": "string",
            "format": "date-time"
          },
          "exit_time": {
            "type": "object",
            "properties": {
              "left_at": {
                "type": "string",
                "format": "date-time"
              },
              "left_reason": {
                "type": "string"
              }
            }
          },
          "bandwidth": {
            "type": "object",
            "properties": {
              "min_sent_bandwidth": {
                "type": "number"
              },
              "max_sent_bandwidth": {
                "type": "number"
              },
              "avg_sent_bandwidth": {
                "type": "number"
              },
              "min_receive_bandwidth": {
                "type": "number"
              },
              "max_receive_bandwidth": {
                "type": "number"
              },
              "avg_receive_bandwidth": {
                "type": "number"
              }
            }
          }
        }
      },
      "SessionSummary": {
        "type": "object",
        "properties": {
          "start_time": {
            "type": "string",
            "format": "date-time"
          },
          "end_time": {
            "type": "string",
            "format": "date-time"
          },
          "actual_end_time": {
            "type": "string",
            "format": "date-time"
          },
          "participants": {
            "type": "array",
            "items": {
              "$ref": "#/components/schemas/ParticipantSummary"
            }
          }
        }
      }
    }
  },
  "paths": {
    "/v1/sessions/{session_id}/summary": {
      "parameters": [
        {
          "name": "session_id",
          "in": "path",
          "required": true,
          "schema": {
            "type": "string",
            "format": "uuid"
          }
        }
      ],
      "get": {
        "tags": [
          "Sessions"
        ],
        "summary": "Get Session Summary",
        "operationId": "getSessionSummary",
        "description": "Here is some further information on the timestamps provided in the response:\n\n- Start time - Scheduled start time for the session\n- End time - Scheduled end time for the session\n- Actual start time - Creation time of the call, typically when host has joined\n- Actual end time - Call recorded as complete, last participant has left\n- Participant entry time - Earliest recorded entry time for the participant, does not include time in Waiting Room\n- Participant exit time - Latest recorded exit time for the participant.\n",
        "responses": {
          "200": {
            "description": "Session Summary",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/SessionSummary"
                }
              }
            }
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  },
  "_id": {
    "buffer": {
      "0": 104,
      "1": 138,
      "2": 232,
      "3": 232,
      "4": 249,
      "5": 76,
      "6": 129,
      "7": 100,
      "8": 54,
      "9": 28,
      "10": 74,
      "11": 255
    }
  }
}
```