Txlog Portal

The Portal Transaction Log Portal API provides access to detailed transaction recordslogs fromfor portalPortal accessservices, pointsenabling within the Zequenze system. These endpoints allow youdevelopers to retrieveretrieve, filter, and analyze user accessauthentication patterns,activities, monitor securitysession events, and generatesystem comprehensiveinteractions. auditThis reportsendpoint is essential for compliancemonitoring user behavior, debugging authentication issues, and operationalgenerating purposes.compliance reports.

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 Portal API enablesallows you to access comprehensive monitoring and auditinglogs of all portal-basedPortal-related transactions within your Zequenze infrastructure. This API is essential for security teams, facility managers, and compliance officers who need to track user access patterns, investigate security incidents, and maintain detailed audit trails.

Portal transactions represent real-time events occurring at physical or virtual access points throughout your organization. EachThese transactionlogs capturescapture criticala informationwide range of activities including user identity,authentication, accesslogin/logout pointevents, location,session timestamp,management, transactionpayment type,processing, and outcome.system Thistriggers.

data

Key is invaluable for:Features:

• SecurityComprehensive MonitoringFiltering:: TrackFilter unauthorizedlogs by transaction type, date range, user, location, and access attempts,point

unusual activityReal-time patterns,Monitoring: Access up-to-date transaction logs for live monitoring Audit Trail: Maintain detailed records for compliance and security breachesauditing CompliancePagination ReportingSupport:: GenerateEfficiently detailedhandle auditlarge trailsdatasets requiredwith bycursor-based regulatorypagination frameworks

Common Use Cases:

Security monitoring and incident investigation User Operationalbehavior Analytics: Understand facility usage patterns, peak access times,analysis and resource utilizationreporting Compliance Incident Investigation: Reconstruct event timelinesauditing and identifydocumentation securityTroubleshooting incidentsauthentication and session issues Performance monitoring of Portal services

The APItransaction supportslogs flexibleinclude filtering26 optionsdifferent allowingtransaction youtypes, from basic authentication (ua) and login events (ui) to queryadvanced transactionsfeatures bylike user,payment location,processing access point, time range,(pp) and transactionemail type.validation Results(ve). areEach paginatedlog forentry optimalprovides performancedetailed whencontext dealingincluding withuser largeinformation, datasetslocation spanningdata, extendedtimestamps, timeand periods.status codes.

---

Endpoints

GET /txlog_portal/

Description: Retrieves a comprehensivepaginated list of portalPortal transactionstransaction logs with advancedcomprehensive filtering capabilities.options. This endpoint is the primary method for accessing historical transaction datadata, monitoring real-time activities, and supportsgenerating multiplereports filterfor parameterssecurity, tocompliance, narrowor resultsanalytical based on specific criteria such as user identity, location, time range, and transaction type.purposes.

Use Cases:

• GenerateMonitor failed authentication attempts for security auditanalysis

Generate compliance reports for specific timedate periods and locationsranges Investigate suspicious access patterns or security incidents MonitorTrack user access frequency and timing patterns Create compliance reports showing detailed access logs Analyze facility usageactivity patterns across different locations Debug authentication issues for specific users or access points Analyze system performance and identify bottlenecks

Full URL Example:

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

Parameters:

Parameter	Type	In	Required	Description
type	string	query	No	Filter transactions by typetransaction type. Options include: ua (e.g.Authenticate), 'access'ui (Login), 'exit'ue (Re-authenticate), 'denied'uo (Logout), 'maintenance')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)
start_date	string	query	No	StartFilter transactions from this date/timetime. filter inSupports ISO format: 2000-01-01, 2000-01-01 00:01:00, or 2000-01-01 00:01:00+00:00
end_date	string	query	No	EndFilter transactions until this date/timetime. filter inSupports ISO format: 2000-01-01, 2000-01-01 00:01:00, or 2000-01-01 00:01:00+00:00
user	integer	query	No	Filter transactions by specific user ID to show activity for a specific user
page	integer	query	No	PageFilter numbertransactions forby paginationspecific (alternativepage to cursor-based pagination)ID
access_point	integer	query	No	Filter transactions by specific access point ID to show transactions for a particular entry/exit
location	integer	query	No	Filter transactions by specific location ID to show transactions within a specific facility or area
cursor	string	query	No	Cursor-basedPagination pagination tokencursor for efficientretrieving navigationnext/previous throughpage large result setsresults
limit	integer	query	No	Maximum numberNumber of results to return per page (default varies,pagination recommended:applies 50-100)if not specified)

cURL Example:

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

Example Response:

{
  "count": 247,
  "next": "https://gate.zequenze.com/api/v1/txlog_portal/?cursor=eyJpZCI6MTIzNDU2fQ%eyJpZCI6MTAwfQ%3D%3D&limit=50"25",
  "previous": null,
  "results": [
    {
      "id": 78945,12345,
      "datetime": "2024-01-15T14:30:25.123456Z",
      "type": "ui",
      "organization": 1,
      "source": "u",
      "status": "h200",
      "message": "User successfully authenticated",
      "service": 101,
      "service_name": "Corporate WiFi Portal",
      "authservice": 201,
      "authservice_name": "LDAP Authentication",
      "user": {
        "id": 123,5678,
      "username": "john.doe"doe@company.com",
      "first_name"email": "John"john.doe@company.com",
      "last_name"external_id": "Doe"emp_12345",
      "employee_id"new_user": false,
      "session_id": "EMP001234"
      }sess_abc123def456",
      "access_point"external_session": {"ext_sess_789xyz",
      "id"payment_transaction_log": 15,null,
      "name"site": "portal.company.com",
      "page": 301,
      "page_url": "https://portal.company.com/login",
      "action": "li",
      "location": 401,
      "location_name": "Main Entrance -Office Building A",
      "code"access_point": 501,
      "access_point_name": "BLDG-A-MAIN"Lobby-AP-01",
      "type"ssid": "entry"
      }CompanyGuest",
      "location"user_agent": {601,
      "id"remote_ip_addr": 5,192168001100,
      "name"captured_ip_addr": "Corporate Headquarters",192168001100,
      "address"mac_addr": "123 Business Plaza",123456789012,
      "timezone"http_referer": "America/New_York"
      },
      "type": "access",
      "status": "granted",
      "timestamp": "2024-01-15T08:42:15Z",
      "method": "card_swipe",
      "device_info": {
        "reader_id": "RDR-001",
        "firmware_version": "2.1.3"
      },
      "metadata": {
        "card_number": "****1234",
        "response_time_ms": 250,
        "additional_verification": false
      }701
    },
    {
      "id": 78944,12344,
      "user": {
        "id": 456,
        "username"datetime": "jane.smith",
        "first_name": "Jane",
        "last_name": "Smith",
        "employee_id": "EMP001235"
      },
      "access_point": {
        "id": 22,
        "name": "Secure Lab - Level 3",
        "code": "LAB-L3-001"2024-01-15T14:28:15.987654Z",
      "type": "restricted"
      }ua",
      "location"organization": {1,
      "id": 7,
        "name"source": "Research Facility",
        "address": "456 Innovation Drive",
        "timezone": "America/New_York"
      },
      "type": "denied"u",
      "status": "insufficient_clearance"h401",
      "timestamp"message": "2024-01-15T08:35:22Z"Authentication failed - invalid credentials",
      "method"service": 101,
      "service_name": "biometric"Corporate WiFi Portal",
      "device_info"authservice": {201,
      "reader_id"authservice_name": "BIO-003"LDAP Authentication",
      "firmware_version"user": null,
      "username": "3.2.1"
      }invalid.user@company.com",
      "metadata": {
        "clearance_required"email": "Level-3"invalid.user@company.com",
      "user_clearance"external_id": null,
      "new_user": false,
      "session_id": "Level-2"sess_failed_auth_123",
      "escalation_triggered"external_session": truenull,
      }"payment_transaction_log": null,
      "site": "portal.company.com",
      "page": 301,
      "page_url": "https://portal.company.com/login",
      "action": "ma",
      "location": 401,
      "location_name": "Main Office Building A",
      "access_point": 501,
      "access_point_name": "Lobby-AP-01",
      "ssid": "CompanyGuest",
      "user_agent": 602,
      "remote_ip_addr": 192168001101,
      "captured_ip_addr": 192168001101,
      "mac_addr": 123456789013,
      "http_referer": 701
    }
  ]
}

Response Codes:

Status	Description
200	Success - Returns paginatedfiltered listtransaction oflog portal transactionsdata
400	Bad Request - Invalid filter parameters or date format or parameter values
401	Unauthorized - Invalid or missing BearerAPI token
403	Forbidden - Insufficient permissions to access transaction logs
422429	UnprocessableToo EntityMany Requests - InvalidRate filterlimit parameterexceeded

combination 500 Internal Server Error - Server-side processing error

---

Common Use Cases

Use Case 1: Security Incident Investigation

WhenMonitor investigatingfailed aauthentication securityattempts breachand orsuspicious unauthorizedlogin accesspatterns attempt,by combinefiltering multiplefor filtersauthentication totypes reconstruct(ua, the incident timeline. Use date range filtersui) with specificfailed accessstatus pointscodes (h401, h403). Combine with IP address and reviewlocation denied transactionsdata to identify suspiciouspotential patterns.security threats.

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

Use Case 2: User AccessActivity Pattern AnalysisReporting

MonitorGenerate specificcomprehensive employeeuser accessactivity patternsreports by filtering transactions for individualspecific users across differentdate timeranges. periods.Include Thissession isdata, usefullocation forinformation, HRand investigations,transaction compliancetypes audits,to orcreate understandingdetailed employeeuser workjourney patterns.reports.

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

Use Case 3: Facility Usage Reporting

Generate comprehensive facility usage reports by filtering transactions for specific locations and time ranges. This data helps optimize facility resources and understand peak usage periods.

https://gate.zequenze.com/api/v1/txlog_portal/?location=5&type=access5678&start_date=2024-01-01&end_date=2024-01-31

Use Case 4:3: Real-timeLocation-Based Security MonitoringAnalytics

ImplementAnalyze real-timeusage monitoringpatterns byacross repeatedlydifferent queryingphysical recent transactions with short time windowslocations and focusing on denied access attemptspoints orto unusualoptimize activitynetwork patterns.resources and identify high-traffic areas.

https://gate.zequenze.com/api/v1/txlog_portal/?location=401&access_point=501&start_date=2024-01-15T08:00:00&type=denied&limit=2001

Use Case 5:4: CompliancePayment AuditTransaction Trail GenerationMonitoring

CreateTrack detailedpayment-related audittransactions trailsand their associated Portal activities for regulatoryfinancial compliance by extracting complete transaction histories for specific time periods, including all user activitiesreconciliation and systemfraud responses.detection.

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

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

Code Name Description ua Authenticate Basic authentication attempts ui Login Successful user login events ue Re-authenticate User re-authentication required uo Logout User logout events uc User capture User data capture events ur User registration New user registration uu User update User profile updates un User activation User account activation 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 tg Pre-login trigger Pre-login system triggers ti Post-login trigger Post-login system triggers to Post-logout trigger Post-logout system triggers te Pre-registration trigger Pre-registration triggers tr Post-registration trigger Post-registration triggers 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 diagnostics

---

Best Practices

• OptimizeUse Date RangeRanges: Queries:Always Usespecify specificreasonable date ranges ratherto thanavoid open-endedretrieving queriesexcessive todata and improve performance and reduce API response times. The API performs better with focused time windows.

• Implement ProperPagination: Pagination:Use For large datasets, usethe cursor-based pagination (cursor parameter) rather than offset-based pagination (page parameter) for consistentlarge resultsdatasets to prevent timeouts and bettermemory performance.

  issues

• 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 TransactionResults: Data:Cache Portalfrequently transaction logs are immutable once created. Implement local caching strategies for historicalaccessed data to reduce API calls and improve application performance. performance

FilterError Early,Handling: FilterAlways Often:check Applystatus multiplecodes filterand parametersimplement toproper reduceerror resulthandling setfor sizefailed atauthentication the API level rather than filtering large datasets in your application code.

attempts

HandleSecurity: RateNever Limitslog Gracefully:or Implement exponential backoff and retry logic forexpose API requests,tokens especiallyin whenclient-side processing large time rangescode or generatingpublic comprehensive reports.

repositories

SecureTime TokenZones: Management: Store and rotate Bearer tokens securely. Transaction logs contain sensitive access control information that requires appropriate security measures.

Monitor for Anomalies: Set up automated monitoring using the API to detect unusual access patterns, such as after-hours access attempts or repeated denied transactions from the same user.

Use Appropriate Date Formats: Always use ISO 8601 formatted datesformat with timezone information for accurate date filtering across different geographical locations and daylight saving time transitions.

regions

---