Skip to main content
GET
/
api
/
v1
/
ssf-receiver-streams
/
{stream_id}
/
stats
GetStats
package main

import(
	"context"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/shared"
	conductoronesdkgo "github.com/conductorone/conductorone-sdk-go"
	"github.com/conductorone/conductorone-sdk-go/pkg/models/operations"
	"log"
)

func main() {
    ctx := context.Background()

    s := conductoronesdkgo.New(
        conductoronesdkgo.WithSecurity(shared.Security{
            BearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
            Oauth: "<YOUR_OAUTH_HERE>",
        }),
    )

    res, err := s.SSFReceiverStream.GetStats(ctx, operations.C1APISSFReceiverV1SSFReceiverStreamServiceGetStatsRequest{
        StreamID: "<id>",
    })
    if err != nil {
        log.Fatal(err)
    }
    if res.SSFReceiverStreamServiceGetStatsResponse != nil {
        // handle response
    }
}
{
  "stats": {
    "eventsActedOnCount": "<string>",
    "eventsFailedCount": "<string>",
    "eventsReceivedCount": "<string>",
    "lastErrorAt": "2023-11-07T05:31:56Z",
    "lastErrorMessage": "<string>",
    "lastEventReceivedAt": "2023-11-07T05:31:56Z",
    "lastVerifiedAt": "2023-11-07T05:31:56Z",
    "streamId": "<string>",
    "transmitterStatus": "<string>",
    "transmitterStatusReason": "<string>"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

​
Authorization
string
header
required

This API uses OAuth2 with the Client Credential flow. Client Credentials must be sent in the BODY, not the headers. For an example of how to implement this, refer to the c1TokenSource.Token() function.

Path Parameters

​
stream_id
string
required

The ID of the SSF receiver stream to get stats for.

Response

200 - application/json

SSFReceiverStreamServiceGetStatsResponse contains the event processing statistics for the stream.

SSFReceiverStreamServiceGetStatsResponse contains the event processing statistics for the stream.

​
stats
Ssf Receiver Stream Stats · object

SSFReceiverStreamStats is a lightweight read-only stats object.