Operational

DocsGithub Open app

Operational

Github Articles Pitch Usecases Playground API

Contents

Start hereAPI DocsIntroductionSend your first eventEvent parametersStructured EventsActionsContextsCategoriesError handlingManualIntroductionBasicsConventionsSetupTest modeNotificationsPWASelf hostingIntroductionInstall locallyInstall on VPSInstall on RenderInstall via DockerInstall via Docker and CoolifyOnboardingSetup .envIntegrationsBest practicesOtherVisionRoadmapContributing

Error handling

Response codes

Every time you make a request, you will get one of these status codes back.

201event created successfully

Event was created successfully.

400event wasn't created

Your event payload was deformed, or badly formatted. See the api docs for info.

401Authentication failed

Your API key was missing or invalid.

500Server error on our side

This indicates the problem was on our end. Please reach out to shash@operational.co if this were to happen.


Error handling

Unlike traditional logs, ops has a fairly diverse API footprint. Eg you can send a lot of crazy stuff.

This means there’s a very likely possibility you might send us a request that won’t make it past our parsers. Don’t worry, we try to ingest the event data whenever possible.

  • userId field is meant to be a string. If you send a number, we’ll simply convert it to a string on our end.
  • If the name field inside a event is too long, it will simply be truncated.
  • Events cannot be more than 100kb big. If they are, we will try to figure out if the event’s type was json and if it was, it will be truncated. If the truncated event is under 100kb, ops will ingest the event.

In these scenarios, we’ll add warnings under the event letting you know that the event was modified so it could be ingested.


Further reading

We recommend reading the owner’s manual to understand best practices.

Categories

Operational

Event tracker for your product.

PrivacyTerms
About the product
  • Playground
  • API
  • Pitch
  • Wordpress plugin
  • Bubble plugin
Related to the product
  • VS Logsnag
  • Open Source
  • Articles
Useful articles for your business
  • Force post: The Payment Hack that lets Merchants charge you without approval
  • 6 Best practices for early stage B2B SaaS customer support
  • Setup event notifications for your SaaS
  • How to get high quality users for your B2B SaaS business?