Helika

Helika Analytics Service

The Helika Analytics Service ingests gameplay and community engagement events. A single POST /events/ operation accepts a batch of typed events (game_id, event_type, event payload) authenticated with an x-api-key header.

GitHub OpenAPI

Documentation

📖
Documentation
https://docs.helika.io/docs/getting-started
📖
APIReference
https://docs.helika.io/reference/create_event_v1_events_post
📖
Authentication
https://raw.githubusercontent.com/api-evangelist/helika/refs/heads/main/authentication/helika-authentication.yml

Specifications

⚙
OpenAPI
https://raw.githubusercontent.com/api-evangelist/helika/refs/heads/main/openapi/helika-events-openapi.json

Other Resources

🔗
Overlay
https://raw.githubusercontent.com/api-evangelist/helika/refs/heads/main/overlays/helika-events-overlay.yaml
🔗
APIsJSON
https://raw.githubusercontent.com/api-evangelist/helika/refs/heads/main/apis.yml

OpenAPI Specification

helika-events-openapi.json Raw ↑ 
{"openapi":"3.1.0","info":{"title":"Helika Analytics Service","version":"1.1.1"},"paths":{"/events/":{"post":{"tags":["Events"],"summary":"Create Events","operationId":"create_events_events__post","parameters":[{"name":"user-agent","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"User-Agent"}},{"name":"x-forwarded-for","in":"header","required":false,"schema":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"X-Forwarded-For"}},{"name":"x-api-key","in":"header","required":true,"schema":{"type":"string","description":"API key","title":"X-Api-Key"},"description":"API key"}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/EventRequest"}}}},"responses":{"200":{"description":"Successful Response","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Response"}}}},"422":{"description":"Validation Error","content":{"application/json":{"schema":{"$ref":"#/components/schemas/HTTPValidationError"}}}}}}}},"components":{"schemas":{"Event":{"properties":{"created_at":{"type":"string","format":"date-time","title":"Created At","description":"Timestamp of the event."},"game_id":{"type":"string","title":"Game Id","description":"Unique identifier for the game."},"event_type":{"type":"string","title":"Event Type","description":"The type of event, e.g. game_start, game_end, etc."},"event":{"type":"object","title":"Event","description":"JSON object containing the event data."}},"type":"object","required":["game_id","event_type","event"],"title":"Event"},"EventRequest":{"properties":{"id":{"anyOf":[{"type":"string"},{"type":"null"}],"title":"Id","description":"Unique identifier this request"},"events":{"items":{"$ref":"#/components/schemas/Event"},"type":"array","title":"Events"}},"type":"object","required":["events"],"title":"EventRequest"},"HTTPValidationError":{"properties":{"detail":{"items":{"$ref":"#/components/schemas/ValidationError"},"type":"array","title":"Detail"}},"type":"object","title":"HTTPValidationError"},"Response":{"properties":{"message":{"type":"string","title":"Message"},"status":{"$ref":"#/components/schemas/StatusEnum"}},"type":"object","required":["message","status"],"title":"Response"},"StatusEnum":{"type":"string","enum":["ok","error","accepted"],"title":"StatusEnum"},"ValidationError":{"properties":{"loc":{"items":{"anyOf":[{"type":"string"},{"type":"integer"}]},"type":"array","title":"Location"},"msg":{"type":"string","title":"Message"},"type":{"type":"string","title":"Error Type"}},"type":"object","required":["loc","msg","type"],"title":"ValidationError"}}}}