Skip to main content

API Activity Logs

Understanding and using API activity logs to track actions in the Axiom system

API Activity Logs

What Are API Logs?

API logs are automatic records of actions taken in the Axiom system. Think of them as a detailed activity history that tracks what users do, when they do it, and what happened as a result. This helps with troubleshooting issues, monitoring system usage, and understanding user behavior.

What Gets Recorded?

The system automatically tracks:

  • User Actions: Who performed the action (which user and account)
  • What Happened: The type of action (creating, updating, deleting data)
  • When: Exact timestamp of the action
  • Where: Which part of the system was accessed
  • Details: What information was sent and what the system responded with
  • Success/Failure: Whether the action completed successfully or encountered an error

What Actions Are Tracked?

The system records actions that change data, such as:

  • Creating new orders, products, or accounts
  • Updating existing information
  • Deleting records
  • Processing payments
  • Managing inventory

Information Stored for Each Action

Each log entry contains:

InformationDescriptionExample
User IDWho performed the actionUser #123
Account ContextWhich business account was activeABC Company account
Action TypeWhat kind of action was takenCreating a new order
System LocationWhich part of the systemShopping cart section
Result CodeWhether it succeeded or failedSuccess (201) or Error (500)
Request DetailsWhat information was providedOrder items, quantities, prices
Response DetailsWhat the system returnedConfirmation message or error details
TimestampWhen it happenedJanuary 15, 2024 at 10:30 AM

Privacy and Security

What's Protected

  • Passwords: Never stored in logs for security
  • Personal Access: Users can only see their own activity logs
  • Secure Access: Requires proper login and permissions to view logs

Data Retention

  • Logs are automatically deleted after 365 days
  • This helps maintain system performance and comply with privacy regulations
  • Important: Save any logs you need for longer-term analysis before they're deleted

How to View Your Activity Logs

Basic Access

To see your recent activity:

  1. Make sure you're logged in to your account
  2. Access the API logs section (requires appropriate permissions)
  3. Your logs will show only activities from your account

Filtering Your Logs

You can narrow down what you see by:

By Result Type

  • Show only successful actions
  • Show only errors or failed actions
  • Example: See all failed payment attempts

By Activity Area

  • Focus on specific parts of the system
  • Example: Show only shopping cart activities

By Time Period

  • Choose how many results to see at once
  • Navigate through different time periods

By Team Member

  • If you manage a team, filter by specific users
  • Useful for tracking individual activity

Example Searches

Finding Recent Errors Look for activities that didn't complete successfully to identify and fix problems.

Tracking High-Activity Areas See which parts of the system are used most frequently by your team.

User Activity Review Monitor what specific team members are doing in the system.

Common Use Cases

1. Troubleshooting Problems

When something goes wrong, logs help you:

  • See exactly what happened before the problem
  • Identify which action caused an issue
  • Understand error messages and their context

2. Monitoring Team Activity

For managers and administrators:

  • Track how team members use the system
  • Identify training needs
  • Monitor compliance with company procedures

3. Understanding System Usage

  • See which features are used most
  • Identify busy periods
  • Plan for system capacity needs

4. Audit and Compliance

  • Maintain records of important business activities
  • Track changes to critical data
  • Support regulatory compliance requirements

Understanding Log Results

Success Indicators

  • 200-299 codes: Action completed successfully

Warning Signs

  • 400-499 codes: Problem with the request (user error)
  • 500-599 codes: System error (technical problem)

Common Result Codes

  • 200: Success - action completed
  • 201: Success - new item created
  • 400: Bad request - check your input
  • 401: Not authorized - login required
  • 403: Permission denied - contact administrator
  • 404: Not found - item doesn't exist
  • 500: Server error - contact technical support

Getting Help

When Logs Show Errors

  1. Note the exact time and error code
  2. Check if the problem persists
  3. Contact technical support with log details

For Access Issues

  • Verify you have the correct permissions
  • Check that you're logged in properly
  • Confirm you're using the right account context

For Technical Questions

  • Provide specific log entries when reporting issues
  • Include timestamps and error codes
  • Describe what you were trying to accomplish

System Maintenance

Automatic Cleanup

  • Logs older than 90 days are automatically removed
  • This keeps the system running efficiently
  • No action needed from users

Performance Optimization

  • The system is designed to log activities without slowing down your work
  • Logs are processed in the background
  • Database is optimized for quick searches

Important Notes

  • Real-time Tracking: Actions are logged immediately as they happen
  • Complete Records: Both successful and failed actions are recorded
  • User-Specific: You only see logs from your own account activities
  • Secure Storage: All log data is encrypted and securely stored
  • No Personal Data: Sensitive information like passwords is never logged

This logging system helps ensure transparency, accountability, and effective troubleshooting while maintaining your privacy and security.