Skip to content
This repository was archived by the owner on Sep 3, 2021. It is now read-only.

Latest commit

 

History

History
304 lines (185 loc) · 7.49 KB

CustomerMetricsApi.md

File metadata and controls

304 lines (185 loc) · 7.49 KB

CustomerMetricsApi

All URIs are relative to /api/v2

Method HTTP request Description
getEvaluations GET /usage/evaluations/{envId}/{flagKey} Get events usage by event id and the feature flag key.
getEvent GET /usage/events/{type} Get events usage by event type.
getEvents GET /usage/events Get events usage endpoints.
getMAU GET /usage/mau Get monthly active user data.
getMAUByCategory GET /usage/mau/bycategory Get monthly active user data by category.
getStream GET /usage/streams/{source} Get a stream endpoint and return timeseries data.
getStreamBySDK GET /usage/streams/{source}/bysdkversion Get a stream timeseries data by source show sdk version metadata.
getStreamSDKVersion GET /usage/streams/{source}/sdkversions Get a stream timeseries data by source and show all sdk version associated.
getStreams GET /usage/streams Returns a list of all streams.
getUsage GET /usage Returns of the usage endpoints available.

getEvaluations

Get events usage by event id and the feature flag key.

Example

 getEvaluations envId=value flagKey=value

Parameters

Name Type Description Notes
envId string The environment id for the flag evaluations in question.
flagKey string The key of the flag we want metrics for.

Return type

StreamSDKVersion

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEvent

Get events usage by event type.

Example

 getEvent type=value

Parameters

Name Type Description Notes
type string The type of event we would like to track.

Return type

StreamSDKVersion

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getEvents

Get events usage endpoints.

Example

 getEvents

Parameters

This endpoint does not need any parameter.

Return type

Events

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMAU

Get monthly active user data.

Example

 getMAU

Parameters

This endpoint does not need any parameter.

Return type

MAU

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getMAUByCategory

Get monthly active user data by category.

Example

 getMAUByCategory

Parameters

This endpoint does not need any parameter.

Return type

MAUbyCategory

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getStream

Get a stream endpoint and return timeseries data.

Example

 getStream source=value

Parameters

Name Type Description Notes
source string The source of where the stream comes from.

Return type

Stream

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getStreamBySDK

Get a stream timeseries data by source show sdk version metadata.

Example

 getStreamBySDK source=value

Parameters

Name Type Description Notes
source string The source of where the stream comes from.

Return type

StreamBySDK

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getStreamSDKVersion

Get a stream timeseries data by source and show all sdk version associated.

Example

 getStreamSDKVersion source=value

Parameters

Name Type Description Notes
source string The source of where the stream comes from.

Return type

StreamSDKVersion

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getStreams

Returns a list of all streams.

Example

 getStreams

Parameters

This endpoint does not need any parameter.

Return type

Streams

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

getUsage

Returns of the usage endpoints available.

Example

 getUsage

Parameters

This endpoint does not need any parameter.

Return type

Usage

Authorization

Token

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]