Add an event

post

https://api.clientsuccess.com/usage/2.0/projects/{projectId}/events/{eventId}

ClientSuccess Usage API allows you to upload usage events programatically that can be tracked and reported in the ClientSuccess platform.

This endpoint collects events. Events are processed and viewed through ClientSuccess.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

projectId

string

required

Project identifier (provided by ClientSuccess during implementation)

eventId

string

required

An event identifier (created by the user and dynamically created)

Query Params

api_key

string

required

The api key for your ClientSuccess API account (provided by ClientSuccess during implementation)

Body Params

value

number

required

MUST be a number and should be set to 1 if an aggregate value is not appropriate. Aggregate use cases include tracking multiple events using a single API submission. Values must be numeric and can be negative.

timestamp

string

OPTIONAL - Provide an ISO 8601 timestamp to override the default timestamp for when the event was created. This is useful where data is being submitted to the API after the activity actually occurred or when backfilling historical data. Example ISO-8601 date strings: 2012-01-01T00:01:00-08:00, 1996-02-29T15:30:00+12:00, 2000-05-30T12:12:12Z. If not provided the current UTC time is used as the event time.

identity

object

required

Response