Fetch details of peer
client.RealtimeKit.Sessions.GetParticipantDataFromPeerID(ctx, appID, peerID, params) (*SessionGetParticipantDataFromPeerIDResponse, error)
GET/accounts/{account_id}/realtime/kit/{app_id}/sessions/peer-report/{peer_id}
Returns details of the given peer ID along with call statistics for the given session ID.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
Accepted Permissions (at least one required)
Fetch details of peer
package main
import (
"context"
"fmt"
"github.com/cloudflare/cloudflare-go"
"github.com/cloudflare/cloudflare-go/option"
"github.com/cloudflare/cloudflare-go/realtime_kit"
)
func main() {
client := cloudflare.NewClient(
option.WithAPIToken("Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY"),
)
response, err := client.RealtimeKit.Sessions.GetParticipantDataFromPeerID(
context.TODO(),
"app_id",
"peer_id",
realtime_kit.SessionGetParticipantDataFromPeerIDParams{
AccountID: cloudflare.F("023e105f4ecef8ad9ca31a8372d0c353"),
},
)
if err != nil {
panic(err.Error())
}
fmt.Printf("%+v\n", response.Data)
}
{
"data": {
"participant": {
"id": "id",
"created_at": "created_at",
"custom_participant_id": "custom_participant_id",
"display_name": "display_name",
"duration": 0,
"joined_at": "joined_at",
"left_at": "left_at",
"peer_report": {
"metadata": {
"audio_devices_updates": [
{}
],
"browser_metadata": {
"browser": "browser",
"browser_version": "browser_version",
"engine": "engine",
"user_agent": "user_agent",
"webgl_support": "webgl_support"
},
"candidate_pairs": {
"consuming_transport": [
{}
],
"producing_transport": [
{
"available_outgoing_bitrate": 0,
"bytes_discarded_on_send": 0,
"bytes_received": 0,
"bytes_sent": 0,
"current_round_trip_time": 0,
"last_packet_received_timestamp": 0,
"last_packet_sent_timestamp": 0,
"local_candidate_address": "local_candidate_address",
"local_candidate_id": "local_candidate_id",
"local_candidate_network_type": "local_candidate_network_type",
"local_candidate_port": 0,
"local_candidate_protocol": "local_candidate_protocol",
"local_candidate_related_address": "local_candidate_related_address",
"local_candidate_related_port": 0,
"local_candidate_type": "local_candidate_type",
"nominated": true,
"packets_discarded_on_send": 0,
"packets_received": 0,
"packets_sent": 0,
"remote_candidate_address": "remote_candidate_address",
"remote_candidate_id": "remote_candidate_id",
"remote_candidate_port": 0,
"remote_candidate_protocol": "remote_candidate_protocol",
"remote_candidate_type": "remote_candidate_type",
"total_round_trip_time": 0
}
]
},
"device_info": {
"cpus": 0,
"is_mobile": true,
"os": "os",
"os_version": "os_version"
},
"events": [
{
"name": "name",
"timestamp": "timestamp"
}
],
"ip_information": {
"asn": {
"asn": "asn"
},
"city": "city",
"country": "country",
"ipv4": "ipv4",
"region": "region",
"timezone": "timezone"
},
"pc_metadata": [
{
"effective_network_type": "effective_network_type",
"reflexive_connectivity": true,
"relay_connectivity": true,
"timestamp": "timestamp",
"turn_connectivity": true
}
],
"room_view_type": "room_view_type",
"sdk_name": "sdk_name",
"sdk_version": "sdk_version",
"selected_device_updates": [
{}
],
"speaker_devices_updates": [
{}
],
"video_devices_updates": [
{}
]
},
"quality": {
"audio_consumer": [
{}
],
"audio_consumer_cumulative": {},
"audio_producer": [
{
"bytes_sent": 0,
"jitter": 0,
"mid": "mid",
"mos_quality": 0,
"packets_lost": 0,
"packets_sent": 0,
"producer_id": "producer_id",
"rtt": 0,
"ssrc": 0,
"timestamp": "timestamp"
}
],
"audio_producer_cumulative": {
"packet_loss": {
"10_or_greater_event_fraction": 0,
"25_or_greater_event_fraction": 0,
"5_or_greater_event_fraction": 0,
"50_or_greater_event_fraction": 0,
"avg": 0
},
"quality_mos": {
"avg": 0,
"p50": 0,
"p75": 0,
"p90": 0
},
"rtt": {
"100ms_or_greater_event_fraction": 0,
"250ms_or_greater_event_fraction": 0,
"500ms_or_greater_event_fraction": 0,
"avg": 0
}
},
"screenshare_audio_consumer": [
{}
],
"screenshare_audio_consumer_cumulative": {},
"screenshare_audio_producer": [
{}
],
"screenshare_audio_producer_cumulative": {},
"screenshare_video_consumer": [
{}
],
"screenshare_video_consumer_cumulative": {},
"screenshare_video_producer": [
{}
],
"screenshare_video_producer_cumulative": {},
"video_consumer": [
{}
],
"video_consumer_cumulative": {},
"video_producer": [
{}
],
"video_producer_cumulative": {}
}
},
"peer_stats": {
"device_info": {
"browser": "browser",
"browser_version": "browser_version",
"cpus": 0,
"engine": "engine",
"is_mobile": true,
"os": "os",
"os_version": "os_version",
"sdk_name": "sdk_name",
"sdk_version": "sdk_version",
"user_agent": "user_agent",
"webgl_support": "webgl_support"
},
"events": [
{
"metadata": {
"connection_info": {
"backend_r_t_t": 0,
"connectivity": {
"host": true,
"reflexive": true,
"relay": true
},
"effective_network_type": "effective_network_type",
"fractional_loss": 0,
"ip_details": {
"asn": {
"asn": "asn"
},
"city": "city",
"country": "country",
"ip": "ip",
"loc": "loc",
"postal": "postal",
"region": "region",
"timezone": "timezone"
},
"jitter": 0,
"location": {
"coords": {
"latitude": 0,
"longitude": 0
}
},
"r_t_t": 0,
"throughput": 0,
"turn_connectivity": true
}
},
"timestamp": "timestamp",
"type": "type"
}
],
"ip_information": {
"asn": {
"asn": "asn"
},
"city": "city",
"country": "country",
"ip_location": "ip_location",
"ipv4": "ipv4",
"org": "org",
"region": "region",
"timezone": "timezone"
},
"precall_network_information": {
"backend_rtt": 0,
"effective_networktype": "effective_networktype",
"fractional_loss": 0,
"jitter": 0,
"reflexive_connectivity": true,
"relay_connectivity": true,
"rtt": 0,
"throughput": 0,
"turn_connectivity": true
}
},
"quality_stats": {
"audio_bandwidth": 0,
"audio_stats": [
{}
],
"average_quality": 0,
"end": "end",
"first_audio_packet_received": "first_audio_packet_received",
"first_video_packet_received": "first_video_packet_received",
"last_audio_packet_received": "last_audio_packet_received",
"last_video_packet_received": "last_video_packet_received",
"peer_ids": [
"string"
],
"start": "start",
"total_audio_packets": 0,
"total_audio_packets_lost": 0,
"total_video_packets": 0,
"total_video_packets_lost": 0,
"video_bandwidth": 0,
"video_stats": [
{}
]
},
"role": "role",
"updated_at": "updated_at",
"user_id": "user_id"
}
},
"success": true
}Returns Examples
{
"data": {
"participant": {
"id": "id",
"created_at": "created_at",
"custom_participant_id": "custom_participant_id",
"display_name": "display_name",
"duration": 0,
"joined_at": "joined_at",
"left_at": "left_at",
"peer_report": {
"metadata": {
"audio_devices_updates": [
{}
],
"browser_metadata": {
"browser": "browser",
"browser_version": "browser_version",
"engine": "engine",
"user_agent": "user_agent",
"webgl_support": "webgl_support"
},
"candidate_pairs": {
"consuming_transport": [
{}
],
"producing_transport": [
{
"available_outgoing_bitrate": 0,
"bytes_discarded_on_send": 0,
"bytes_received": 0,
"bytes_sent": 0,
"current_round_trip_time": 0,
"last_packet_received_timestamp": 0,
"last_packet_sent_timestamp": 0,
"local_candidate_address": "local_candidate_address",
"local_candidate_id": "local_candidate_id",
"local_candidate_network_type": "local_candidate_network_type",
"local_candidate_port": 0,
"local_candidate_protocol": "local_candidate_protocol",
"local_candidate_related_address": "local_candidate_related_address",
"local_candidate_related_port": 0,
"local_candidate_type": "local_candidate_type",
"nominated": true,
"packets_discarded_on_send": 0,
"packets_received": 0,
"packets_sent": 0,
"remote_candidate_address": "remote_candidate_address",
"remote_candidate_id": "remote_candidate_id",
"remote_candidate_port": 0,
"remote_candidate_protocol": "remote_candidate_protocol",
"remote_candidate_type": "remote_candidate_type",
"total_round_trip_time": 0
}
]
},
"device_info": {
"cpus": 0,
"is_mobile": true,
"os": "os",
"os_version": "os_version"
},
"events": [
{
"name": "name",
"timestamp": "timestamp"
}
],
"ip_information": {
"asn": {
"asn": "asn"
},
"city": "city",
"country": "country",
"ipv4": "ipv4",
"region": "region",
"timezone": "timezone"
},
"pc_metadata": [
{
"effective_network_type": "effective_network_type",
"reflexive_connectivity": true,
"relay_connectivity": true,
"timestamp": "timestamp",
"turn_connectivity": true
}
],
"room_view_type": "room_view_type",
"sdk_name": "sdk_name",
"sdk_version": "sdk_version",
"selected_device_updates": [
{}
],
"speaker_devices_updates": [
{}
],
"video_devices_updates": [
{}
]
},
"quality": {
"audio_consumer": [
{}
],
"audio_consumer_cumulative": {},
"audio_producer": [
{
"bytes_sent": 0,
"jitter": 0,
"mid": "mid",
"mos_quality": 0,
"packets_lost": 0,
"packets_sent": 0,
"producer_id": "producer_id",
"rtt": 0,
"ssrc": 0,
"timestamp": "timestamp"
}
],
"audio_producer_cumulative": {
"packet_loss": {
"10_or_greater_event_fraction": 0,
"25_or_greater_event_fraction": 0,
"5_or_greater_event_fraction": 0,
"50_or_greater_event_fraction": 0,
"avg": 0
},
"quality_mos": {
"avg": 0,
"p50": 0,
"p75": 0,
"p90": 0
},
"rtt": {
"100ms_or_greater_event_fraction": 0,
"250ms_or_greater_event_fraction": 0,
"500ms_or_greater_event_fraction": 0,
"avg": 0
}
},
"screenshare_audio_consumer": [
{}
],
"screenshare_audio_consumer_cumulative": {},
"screenshare_audio_producer": [
{}
],
"screenshare_audio_producer_cumulative": {},
"screenshare_video_consumer": [
{}
],
"screenshare_video_consumer_cumulative": {},
"screenshare_video_producer": [
{}
],
"screenshare_video_producer_cumulative": {},
"video_consumer": [
{}
],
"video_consumer_cumulative": {},
"video_producer": [
{}
],
"video_producer_cumulative": {}
}
},
"peer_stats": {
"device_info": {
"browser": "browser",
"browser_version": "browser_version",
"cpus": 0,
"engine": "engine",
"is_mobile": true,
"os": "os",
"os_version": "os_version",
"sdk_name": "sdk_name",
"sdk_version": "sdk_version",
"user_agent": "user_agent",
"webgl_support": "webgl_support"
},
"events": [
{
"metadata": {
"connection_info": {
"backend_r_t_t": 0,
"connectivity": {
"host": true,
"reflexive": true,
"relay": true
},
"effective_network_type": "effective_network_type",
"fractional_loss": 0,
"ip_details": {
"asn": {
"asn": "asn"
},
"city": "city",
"country": "country",
"ip": "ip",
"loc": "loc",
"postal": "postal",
"region": "region",
"timezone": "timezone"
},
"jitter": 0,
"location": {
"coords": {
"latitude": 0,
"longitude": 0
}
},
"r_t_t": 0,
"throughput": 0,
"turn_connectivity": true
}
},
"timestamp": "timestamp",
"type": "type"
}
],
"ip_information": {
"asn": {
"asn": "asn"
},
"city": "city",
"country": "country",
"ip_location": "ip_location",
"ipv4": "ipv4",
"org": "org",
"region": "region",
"timezone": "timezone"
},
"precall_network_information": {
"backend_rtt": 0,
"effective_networktype": "effective_networktype",
"fractional_loss": 0,
"jitter": 0,
"reflexive_connectivity": true,
"relay_connectivity": true,
"rtt": 0,
"throughput": 0,
"turn_connectivity": true
}
},
"quality_stats": {
"audio_bandwidth": 0,
"audio_stats": [
{}
],
"average_quality": 0,
"end": "end",
"first_audio_packet_received": "first_audio_packet_received",
"first_video_packet_received": "first_video_packet_received",
"last_audio_packet_received": "last_audio_packet_received",
"last_video_packet_received": "last_video_packet_received",
"peer_ids": [
"string"
],
"start": "start",
"total_audio_packets": 0,
"total_audio_packets_lost": 0,
"total_video_packets": 0,
"total_video_packets_lost": 0,
"video_bandwidth": 0,
"video_stats": [
{}
]
},
"role": "role",
"updated_at": "updated_at",
"user_id": "user_id"
}
},
"success": true
}