Summary
- Last UpdatedJan 20, 2023
- 2 minute read
API that returns the summary information of the community's stream consumption
Community Summary Information
Gets community summary information. This includes counts regarding the number of streams that have been shared with the community by the caller of this API as well the total number of streams that have been shared with the community by all members.
Request
GET /api/v1-preview/communities/{communityId}/summary
?excludeCrossRegions={excludeCrossRegions}
Parameters
string communityId
Community identifier.
[optional] boolean excludeCrossRegions
A value indicating this request should exclude results from regions that are different from the calling region.
Response
| Status Code | Body Type | Description |
|---|---|---|
| 200 | CommunitySummaryInformation | Returns community summary information of type CommunitySummaryInformation. |
| 400 | ErrorResponse | Bad Request. The server could not understand the request. |
| 401 | None | Unauthorized. The client has not been authenticated. |
| 403 | ErrorResponse | Forbidden. The client does not have the required permissions to make the request. |
| 404 | ErrorResponse | Not Found. The requested tenant or community was not found. |
| 408 | ErrorResponse | Request Timeout. The request has timed out. |
| 500 | ErrorResponse | Internal Server Error. The server has encountered a situation it does not know how to handle. |
Example response body
200 Response (CommunitySummaryInformation)
{
"TotalStreams": 0,
"CommunitySummaryInformationForTenants": [
{
"TenantId": "string",
"StreamsContributed": 0
}
]
}
Definitions
CommunitySummaryInformation
The CommunitySummaryInformation object. This is the model representation exposed to callers of controller endpoints.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| TotalStreams | int32 | false | false | The number of streams that have been contributed to the community by all member tenants, including the calling tenant |
| CommunitySummaryInformationForTenants | [CommunitySummaryInformationForTenant] | false | true | A list of per-tenant community summary information objects. |
{
"TotalStreams": 0,
"CommunitySummaryInformationForTenants": [
{
"TenantId": "string",
"StreamsContributed": 0
}
]
}
CommunitySummaryInformationForTenant
The CommunitySummaryInformationForTenant object. Contains information about the streams contributed to a community by a particular tenant. A list of these objects are part of the CommunitySummaryInformation class.
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| TenantId | string | false | true | The tenant id of a community member. This is extracted from a stream that is shared with the community. |
| StreamsContributed | int32 | false | false | The number of streams that have been contributed to the community by the tenant. |
{
"TenantId": "string",
"StreamsContributed": 0
}
ErrorResponse
Properties
| Property Name | Data Type | Required | Nullable | Description |
|---|---|---|---|---|
| OperationId | string | false | true | OperationId of the action that caused the error |
| Error | string | false | true | Error description |
| Reason | string | false | true | Reason for the error |
| Resolution | string | false | true | Resolution for the Error |
{
"OperationId": "string",
"Error": "string",
"Reason": "string",
"Resolution": "string"
}