Get Stats

GetStats retrieves event processing statistics for a specific SSF receiver stream, including counts of received, acted-on, and failed events.

GET /api/v1/ssf-receiver-streams/{stream_id}/stats

GetStats

Go

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
    }
}

import { ConductoroneSDKTypescript } from "conductorone-sdk-typescript";

const conductoroneSDKTypescript = new ConductoroneSDKTypescript({
  security: {
    bearerAuth: "<YOUR_BEARER_TOKEN_HERE>",
    oauth: "<YOUR_OAUTH_HERE>",
  },
});

async function run() {
  const result = await conductoroneSDKTypescript.ssfReceiverStream.getStats({
    streamId: "<id>",
  });

  console.log(result);
}

run();

curl --request GET \
  --url https://{tenantDomain}.conductor.one/api/v1/ssf-receiver-streams/{stream_id}/stats \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://{tenantDomain}.conductor.one/api/v1/ssf-receiver-streams/{stream_id}/stats"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://{tenantDomain}.conductor.one/api/v1/ssf-receiver-streams/{stream_id}/stats', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://{tenantDomain}.conductor.one/api/v1/ssf-receiver-streams/{stream_id}/stats",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.get("https://{tenantDomain}.conductor.one/api/v1/ssf-receiver-streams/{stream_id}/stats")
  .header("Authorization", "Bearer <token>")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://{tenantDomain}.conductor.one/api/v1/ssf-receiver-streams/{stream_id}/stats")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

200

{
  "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 | null

SSFReceiverStreamStats is a lightweight read-only stats object.

Show child attributes