Txlog Portal

Endpoints Summary

Method Path Swagger GET /txlog_portal/ Swagger ↗

---

The Portal Transaction Log Portal API provides access to detailed transaction logsrecords forfrom Portalthe services,Zequenze enablingportal developersauthentication system. This endpoint allows you to retrieve, filter, and analyze user authentication activities,events, session events,activities, and system interactions. This endpoint is essentialinteractions for monitoringmonitoring, user behavior, debugging authentication issues,auditing, and generatingtroubleshooting compliance reports.purposes.

Base URL: https://gate.zequenze.com/api/v1

Authentication: All endpoints require a Bearer token:

Authorization: Bearer <your-api-token>

---

Overview

The Portal Transaction Log PortalAPI is designed for system administrators, security analysts, and developers who need to monitor and audit portal authentication activities. This API allowsprovides youcomprehensive access to access comprehensivetransaction logs of all Portal-related transactions within your organization. These logsthat capture aevery wideuser rangeinteraction ofwith activitiesthe authentication portal, including userlogins, authentication,logouts, login/logoutregistrations, events,password session management, payment processing,changes, and various system triggers.events.

Key Features:

• Comprehensive Filtering:Transaction Types: Track 26 different transaction types from user authentication to payment processing

Advanced Filtering: Filter logs by transaction type, date range,ranges, user, location, access point, and accesstransaction pointtype Real-time Monitoring:Monitoring: Access up-to-date transaction logsdata for live monitoring dashboards Audit Trail:Compliance: Maintain detailed recordsaudit trails for compliancesecurity and securitycompliance auditingrequirements PaginationTroubleshooting Support:Support: EfficientlyIdentify handleauthentication largeissues datasetsand withuser cursor-basedexperience paginationproblems

Common Use Cases:

• Security monitoring and incidentintrusion investigationdetection
• User behavior analysis and reportingsession tracking
• Compliance auditingreporting and documentationaudit trail generation
• TroubleshootingSystem authenticationperformance monitoring and session issuestroubleshooting
• PerformanceCustomer monitoringsupport ofand Portaluser servicesassistance

The transaction logs include 26 different transaction types, from basic authentication (ua) and login events (ui) to advanced features like payment processing (pp) and email validation (ve). Each log entry provides detailed contextmetadata includingsuch as IP addresses, user information,agents, session IDs, location data, timestamps,information, and status codes.codes, providing a complete picture of portal activity.

---

Endpoints

GET /txlog_portal/

Description: Retrieves a paginated list of Portalportal transaction logsrecords with comprehensive filtering options.capabilities. This endpoint is the primary methodessential for accessing historical transaction data, monitoring real-timeuser authentication activities, analyzing login patterns, troubleshooting authentication issues, and generating reportsaudit forreports. security,Each compliance,transaction orrecord analyticalcontains purposes.detailed information about user interactions with the portal authentication system.

Use Cases:

• Monitor failed authentication attempts for security analysis
• Generate compliance reports forshowing user access patterns

Troubleshoot authentication issues by filtering specific dateuser rangessessions TrackAnalyze userportal activityusage patternsstatistics across different locations Debug authentication issues for specific users orand access points AnalyzeTrack system performanceregistration and identifyuser bottlenecksmanagement activities

Full URL Example:

https://gate.zequenze.com/api/v1/txlog_portal/?type=ui&start_date=2024-01-01&end_date=2024-01-31&limit=50

Parameters:

Parameter	Type	In	Required	Description
type	string	query	No	Filter by transaction type. OptionsUse include:'ui' uafor (Authenticate),login, ui'uo' (Login),for uelogout, (Re-authenticate),'ur' uofor (Logout),registration, uc (User capture), ur (User registration), uu (User update), un (User activation), up (Password change), um (User activated API), ai (Auto-login), aa (Auto-authenticate), st (Session timeout), si (Idle timeout), di (Disconnect), tg (Pre-login trigger), ti (Post-login trigger), to (Post-logout trigger), te (Pre-registration trigger), tr (Post-registration trigger), tp (Pre-update trigger), tu (Post-update trigger), ve (Email validation), vt (Telephone validation), pp (Payment process), zz (Service test)etc.
start_date	string	query	No	FilterStart transactionsdate fromfor thisfiltering date/time. Supports (ISO format: 2000-01-01, 2000-2024-01-01 or 2024-01-01T00:00:01:00, 2000-01-01 00:01:00+00:0000Z)
end_date	string	query	No	FilterEnd transactionsdate untilfor thisfiltering date/time. Supports (ISO format: 2000-2024-01-01,31 2000-or 2024-01-01 00:01:00, 2000-01-01 00:01:00+00:0031T23:59:59Z)
user	integer	query	No	Filter transactions byfor a specific user ID
page	integer	query	No	Filter transactions byfrom a specific page ID
access_point	integer	query	No	Filter transactions by specific access point ID (WiFi hotspot, portal location)
location	integer	query	No	Filter transactions by specific location ID (physical location or site)
cursor	string	query	No	Pagination cursor for retrievingefficient next/previouslarge pagedataset resultstraversal
limit	integer	query	No	Number of results to return per page (defaultdefault: pagination20, appliesmax: if not specified)100)

cURL Example:

curl -X GET "https://gate.zequenze.com/api/v1/txlog_portal/?type=ui&start_date=2024-01-01&limit=25" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -H "Content-Type: application/json"

Example Response:

{
  "next": "https://gate.zequenze.com/api/v1/txlog_portal/?cursor=eyJpZCI6MTAwfQ%3D%3D&limit=25",
  "previous": null,
  "results": [
    {
      "id": 12345,
      "datetime": "2024-01-15T14:30:25.123456Z",
      "type": "ui",
      "organization": 1,
      "source": "u",
      "status": "h200",
      "message": "User successfullylogin authenticated"successful",
      "service": 101,
      "service_name": "Corporate WiFi Portal",
      "authservice": 201,
      "authservice_name": "LDAP Authentication",
      "user": 5678,5432,
      "username": "john.doe@company.com"doe",
      "email": "john.doe@company.com",
      "external_id": "emp_12345",
      "new_user": false,
      "session_id": "sess_abc123def456"sess_abc123xyz789",
      "external_session": "ext_sess_789xyz"ldap_session_456",
      "payment_transaction_log": null,
      "site": "corporate-portal.company.com",
      "page": 301,10,
      "page_url": "https://corporate-portal.company.com/login",
      "action": "li",
      "location": 401,15,
      "location_name": "Main OfficeHeadquarters Building A",
      "access_point": 501,42,
      "access_point_name": "Lobby-AP-01"Floor3-West",
      "ssid": "CompanyGuest"Corporate_WiFi",
      "user_agent": 601,301,
      "remote_ip_addr": 192168001100,987654321,
      "captured_ip_addr": 192168001100,987654321,
      "mac_addr": 123456789012,123456789,
      "http_referer": 701501
    },
    {
      "id": 12344,
      "datetime": "2024-01-15T14:28:15.987654Z"789012Z",
      "type": "ua"ur",
      "organization": 1,
      "source": "u",
      "status": "h401"h201",
      "message": "AuthenticationUser failedregistration - invalid credentials"completed",
      "service": 101,
      "service_name": "Corporate WiFi Portal",
      "authservice": 201,null,
      "authservice_name": "LDAP Authentication",null,
      "user": null,5433,
      "username": "invalid.user@company.com"jane.smith",
      "email": "invalid.user@company.jane.smith@company.com",
      "external_id": null,
      "new_user": false,true,
      "session_id": "sess_failed_auth_123"sess_def456uvw012",
      "external_session": null,
      "payment_transaction_log": null,
      "site": "corporate-portal.company.com",
      "page": 301,12,
      "page_url": "https://corporate-portal.company.com/login"register",
      "action": "ma"rg",
      "location": 401,15,
      "location_name": "Main OfficeHeadquarters Building A",
      "access_point": 501,43,
      "access_point_name": "Lobby-AP-01"Floor2-East",
      "ssid": "CompanyGuest"Guest_WiFi",
      "user_agent": 602,302,
      "remote_ip_addr": 192168001101,987654322,
      "captured_ip_addr": 192168001101,987654322,
      "mac_addr": 123456789013,123456790,
      "http_referer": 701502
    }
  ]
}

Response Codes:

Status Description 200 Success - Returns filtered transaction log data 400 Bad Request - Invalid filter parameters or date format 401 Unauthorized - Invalid or missing API token 403 Forbidden - Insufficient permissions to access transaction logs 429 Too Many Requests - Rate limit exceeded 500 Internal Server Error - Server-side processing error

---

Common Use Cases

Use Case 1: Security Incident Investigation

Monitor failed authentication attempts and suspicious login patterns by filtering for authentication types (ua, ui) with failed status codes (h401, h403). Combine with IP address and location data to identify potential security threats.

https://gate.zequenze.com/api/v1/txlog_portal/?type=ua&start_date=2024-01-15T00:00:00&end_date=2024-01-15T23:59:59

Use Case 2: User Activity Reporting

Generate comprehensive user activity reports by filtering transactions for specific users across date ranges. Include session data, location information, and transaction types to create detailed user journey reports.

https://gate.zequenze.com/api/v1/txlog_portal/?user=5678&start_date=2024-01-01&end_date=2024-01-31

Use Case 3: Location-Based Analytics

Analyze usage patterns across different physical locations and access points to optimize network resources and identify high-traffic areas.

https://gate.zequenze.com/api/v1/txlog_portal/?location=401&access_point=501&start_date=2024-01-01

Use Case 4: Payment Transaction Monitoring

Track payment-related transactions and their associated Portal activities for financial reconciliation and fraud detection.

https://gate.zequenze.com/api/v1/txlog_portal/?type=pp&start_date=2024-01-01

Use Case 5: System Performance Monitoring

Monitor session timeouts, disconnections, and system triggers to identify performance issues and optimize Portal configuration.

https://gate.zequenze.com/api/v1/txlog_portal/?type=st&type=si&type=di&start_date=2024-01-15

---

Transaction Types Reference

Reference:

Code	NameDescription	DescriptionUse Case
ua	Authenticate	BasicInitial authentication attempts
ui	Login	Successful user login eventslogins
ue	Re-authenticate	UserSession re-authentication required
uo	Logout	User logout events
uc	User capture	User dataData capture eventsduring registration
ur	User registration	New user registrationaccount creation
uu	User update	UserProfile profileor account updates
un	User activation	User accountAccount activation events
up	Password change	Password modification events
um	User activated API	API-triggered user activation
ai	Auto-login	Automatic login processes
aa	Auto-authenticate	Automatic authentication
st	Session timeout	Session expiration events
si	Idle timeout	Idle session termination
di	Disconnect	Manual or forced disconnections

Response Codes:

Status Description tg200 Pre-loginSuccess trigger- Pre-loginReturns systemfiltered triggerstransaction records ti400 Post-loginBad triggerRequest Post-login- systemInvalid triggersfilter parameters or date format to401 Post-logoutUnauthorized trigger- Post-logoutInvalid systemor triggersmissing API token te403 Pre-registrationForbidden trigger- Pre-registrationInsufficient triggerspermissions to access transaction logs tr429 Post-registrationToo triggerMany Post-registrationRequests triggers- Rate limit tp Pre-update trigger Pre-update system triggers tu Post-update trigger Post-update system triggers ve Email validation Email verification processes vt Telephone validation Phone number verification pp Payment process Payment-related transactions zz Service test System testing and diagnosticsexceeded

---

Common Use Cases

Use Case 1: Security Monitoring Dashboard

Monitor failed authentication attempts and suspicious login patterns by filtering for specific status codes and authentication types.

# Get failed login attempts in the last 24 hours
curl -X GET "https://gate.zequenze.com/api/v1/txlog_portal/?type=ui&status=u401&start_date=2024-01-15T00:00:00Z&end_date=2024-01-15T23:59:59Z" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Use Case 2: User Session Analysis

Track a specific user's authentication journey by filtering their transactions across different session activities.

# Get all transactions for user ID 5432 in January 2024
curl -X GET "https://gate.zequenze.com/api/v1/txlog_portal/?user=5432&start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Use Case 3: Location-Based Usage Reports

Generate usage statistics for specific locations or access points to understand traffic patterns and capacity planning.

# Get all transactions from a specific access point
curl -X GET "https://gate.zequenze.com/api/v1/txlog_portal/?access_point=42&start_date=2024-01-01&limit=100" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Use Case 4: Registration and User Management Audit

Track user registration activities and account management operations for compliance reporting.

# Get all registration-related transactions
curl -X GET "https://gate.zequenze.com/api/v1/txlog_portal/?type=ur,uu,un&start_date=2024-01-01&end_date=2024-01-31" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

Use Case 5: Payment Transaction Monitoring

Monitor payment-related portal activities for e-commerce or paid access scenarios.

# Get payment process transactions
curl -X GET "https://gate.zequenze.com/api/v1/txlog_portal/?type=pp&start_date=2024-01-01" \
  -H "Authorization: Bearer YOUR_API_TOKEN"

---

Best Practices

• Use Date Ranges:Filtering: Always specify reasonableapply date ranges to avoidlimit retrievingresult excessive datasets and improve performancequery performance. Large unbounded queries may timeout or hit rate limits.

• Implement Pagination:Pagination: Use the cursor-based pagination for large datasets torather preventthan timeoutsrequesting andall memoryrecords issuesat once. The cursor parameter provides better performance than offset-based pagination.

• Filter Strategically: Combine multiple filters (type, user, location) to narrow down results effectively

Monitor Rate Limits: Implement proper rate limiting and retry logic to handle API quotas gracefully

Cache Results:Common Queries: Cache frequently accessed data like daily statistics or user lookup results to reduce API calls and improve application performanceperformance.

Monitor Rate Limits: Transaction log endpoints may have strict rate limits. Implement exponential backoff and respect HTTP 429 responses.

Secure Token Storage: Store API tokens securely and rotate them regularly. Transaction logs contain sensitive user information and require proper authentication.

Filter Efficiently: Use specific filters (type, user, location) to reduce payload size and improve response times. Avoid broad queries during peak hours.

Error Handling:Handling: AlwaysImplement check status codes and implement properrobust error handling for failednetwork authenticationtimeouts, attemptsAPI errors, and malformed responses. Transaction logs are critical for security monitoring.

Security:Data Retention Awareness: NeverUnderstand your organization's log orretention exposepolicies. APIHistorical tokensdata inmay client-sidenot codebe oravailable publicbeyond repositories

certain time Timeperiods. Zones: Use ISO format with timezone information for accurate date filtering across different regions

---