Python — Analytics and Feedback

​

Analytics

import lerix

lerix.init(api_key="...", project_id="...")

lerix.track("invoice_paid", {"amount": 42.5, "currency": "OMR", "first": True}, user_id=user.id)
lerix.track("nightly_export_finished")

• user_id is your own ID for the person the event is about, the same one your apps pass to setUser(). Events without it belong to one anonymous service user, so pass it whenever the event is about someone.
• Names start with a letter, then letters, digits, spaces, _, ., : or - (2 to 64 characters). An event with an invalid name is dropped (and logged with debug=True).
• Props are a dict of up to 25 keys. Keys start with a letter or _, then letters, digits, _, . or -. Values are strings (up to 1,024 characters), finite numbers, bools or None. Invalid entries are dropped one by one; nested dicts and lists aren’t supported.

​

Delivery

lerix.init(
    api_key="...",
    project_id="...",
    analytics={"flush_interval": 5, "flush_at": 50, "max_batch_size": 100, "max_queue_size": 1000},
)

lerix.init(api_key="...", project_id="...", analytics=False)  # track() becomes a no-op

lerix.analytics.set_enabled(False)  # stop recording and clear the buffer (e.g. a user opted out)
lerix.analytics.flush(timeout=5)    # send now; True when it finished in time

​

Environment

​

Feedback

from lerix import FeedbackAttachment

feedback_id = lerix.feedback.submit(
    message="The export button does nothing",
    email="ana@example.com",           # optional
    labels=["bug"],                    # label keys from the dashboard
    user_id=user.id,                   # optional, your own ID for the person
    custom={"plan": "pro"},            # optional, up to 50 keys / 16 KB of JSON
    attachments=[FeedbackAttachment(data=png_bytes, width=1280, height=800)],
)

• message is trimmed and must be 1 to 4,000 characters.
• attachments: up to 5 PNG, JPEG or WebP images of up to 5 MB each, as bytes, FeedbackAttachment or a dict with the same fields. The type is read from the bytes; a content_type that disagrees is an error.
• Inside a traced request, the feedback is linked to the request’s trace.
• Unlike track, submit blocks and raises lerix.LerixApiError: code INVALID_FEEDBACK for bad input (nothing is sent), or the API error after two retries of a network error, 429 or 5xx. Retries reuse the same client ID, so the feedback is never created twice. It returns None with enabled=False.