diff --git a/source/includes/collector-api/_actions-api.md b/source/includes/collector-api/_actions-api.md index 07e79f5..cf9da05 100644 --- a/source/includes/collector-api/_actions-api.md +++ b/source/includes/collector-api/_actions-api.md @@ -4,11 +4,11 @@ **`POST https://api.moesif.net/v1/actions`** -Log a single custom action to Moesif. An action represents something a customer performed on your website -such as _Sign In_ or _Purchased Subscription_. Each action consists of an _Action Name_ and optional _Metadata_. +Log a single action to Moesif. +Actions represent events that occur within your application at a specific point in time. They can be tracked within your UI (such as "User Clicked Sign Up") or from your backend (such as "SMS Job Finished"). Each action consists of a required _Action Name_ and optional _Metadata_. **An example tracking actions using moesif-browser-js:** @@ -82,7 +82,7 @@ moesif.track('Clicked Sign Up', { |Name|Type|Required|Description| |-----------|-----------|-----------|-----------| transaction_id | string | false | A random 36 char UUID for this event. If set, Moesif will deduplicate events using this id and ensure idempotency. -action_name | string | __true__ | A recognizable name such as Clicked Sign Up or Purchased Subscription +action_name | string | __true__ | A recognizable name such as Clicked Sign Up or SMS Job Finished session_token | string | false | The customer's current session token as a string. user_id | string | false | Associate this API call to a [user](#users). Typically, a real person. company_id | string | false | Associate this API call to a [company](#companies) (Required for metered billing). @@ -98,15 +98,14 @@ request |object | __true__ | The object containing the action's request context. **`POST https://api.moesif.net/v1/actions/batch`** -Log a batch of custom action to Moesif. An action represents something a customer performed on your website -such as _Sign In_ or _Purchased Subscription_. Each action consists of an _Action Name_ and optional _Metadata_. - -This API takes an array form of the same model defined for track single action. -The maximum batch size is **12MB**. Break up larger batches. +Log a batch of actions to Moesif. +Actions represent events that occur within your application at a specific point in time. They can be tracked within your UI (such as "User Clicked Sign Up") or from your backend (such as "SMS Job Finished"). Each action consists of a required _Action Name_ and optional _Metadata_. +This API accepts an array of actions as the payload +The maximum batch size is **15MB**. Break up larger batches into smaller batches. **An example tracking actions using moesif-browser-js:** @@ -196,7 +195,7 @@ moesif.track('Clicked Sign Up', { |Name|Type|Required|Description| |-----------|-----------|-----------|-----------| transaction_id | string | false | A random 36 char UUID for this event. If set, Moesif will deduplicate events using this id and ensure idempotency. Moesif will still deduplicate even across different size batches. -action_name | string | __true__ | A recognizable name such as Clicked Sign Up or Purchased Subscription +action_name | string | __true__ | A recognizable name such as Clicked Sign Up or SMS Job Finished session_token | string | false | The customer's current session token as a string. user_id | string | false | Associate this API call to a [user](#users). Typically, a real person. company_id | string | false | Associate this API call to a [company](#companies) (Required for metered billing). diff --git a/source/includes/collector-api/_events-api.md b/source/includes/collector-api/_events-api.md index 2f98d3d..3fc3236 100644 --- a/source/includes/collector-api/_events-api.md +++ b/source/includes/collector-api/_events-api.md @@ -4,8 +4,8 @@ **`POST https://api.moesif.net/v1/events`** -Log a single API call to Moesif as an event. -The request payload is a single API event containing the API request, the API response, and any custom event metadata. +Log an API call to Moesif. API Calls in Moesif represent a full API operation or span (in OTel terminology). +Each API call is a structured log containing the API request, the API response, start and end time, context, and any custom event metadata.