--- title: "Security Logs Services" slug: "security-logs-services-1" updated: 2025-01-30T15:04:37Z published: 2025-01-30T15:04:37Z canonical: "kb.easysend.io/security-logs-services-1" --- > ## Documentation Index > Fetch the complete documentation index at: https://kb.easysend.io/llms.txt > Use this file to discover all available pages before exploring further. # Security Logs Services ## Article Overview The following article describes EasySend's security logs services feature. It provides background, information about the API structure and how to use it. ## Background The Security Logs Services feature allows you to receive a pre-set payload (as a textual JSON or as a JSON file) based on the Elastic Common Schema (ECS) version 8.11 format containing various information regarding transactions at chosen security events that occur. The JSON is sent using a service. The included events are: - Authentication events for all auth providers: - CheckAuthResponseMissingCredentials - CheckAuthResponseAuthenticationSucceed - CheckAuthResponseAuthenticationError - CheckAuthResponseAuthenticationFailed NOTEEasySend's standard OTP contains additional information regarding page and action. - Link Sent event - Opened event - Data Submitted event - When the user clicks the submit button - Step Completed event - When a step is completed - Completed event - When the entire workflow is completed ## Security Logs by Service for additional information see the [Security Logs](/v1/docs/security-logs-1) article. ## Security Logs by API To retrieve security logs via API, you must construct the request as follows: ### **Method** GET ### **URL** /player/api/get-security-logs ### **Headers** apiKey - the value will be the API key set in the EASYSEND_SECURITY_LOGS_API_KEY environment variable. NOTEIf you do not know your API key, please get in touch with support. ### **Parameters** NOTEAll date and time parameters are based on the UTC timezone. - start_time - indicating when the security event occurred in YYYYMMDDHHMMSS format. This parameter is required. - end_type - indicating the time until the security event occurred in YYYYMMDDHHMMSS format. This parameter is optional, if missing, the default value will be until the current time. - app_type - player. This parameter is optional, if missing, both Builder and Player security logs will be retrieved. ### Response **Error responses:** - 401 - Unauthorized - usually due to missing or wrong API key. - 500 - Nonspecific error - this can happen due to various server-related issues. - 400 - Bad request - this can happen due to missing start_time, bad time format, or invalid app_type. - 408 - Request timeout - a request limited to 55 seconds. If reaching the timeout, an option is to change start_time and end_time to divide the request. **Success Response:** In case of success (200), the response will happen in streaming, returning chunks in each response divided into pages. **Headers:** - Number-Of-Pages - the number of pages in the response. Each page will contain up to 10,000 security log entries. - Number-Of-Results - the total number of results. **Response body example:** ```json [ { "pageNumber": , "results": , "securityLogs": [ , , ... ] }, { "pageNumber": , "results": , "securityLogs": [ , , ... ] } ] ``` Importnat!By default, security logs are kept for 48 hours from the time of creation. There is no way to restore deleted entries. ### How to Use Important!An environment variable and customer settings configuration are required. Please contact our support team for assistance. **Customer Settings Configuration:** - Choosing which events and which service to run ![](https://cdn.document360.io/45e1a1b1-1964-46f1-939e-f40bde9b50fa/Images/Documentation/image-1738248576185.png) - Setting delivery method: - API Call Only - the Player will store the logs in a designated table and the logs can be retrieved through an API call. - API Call and Custom Service - the logs will be stored in the table and will be able to be retrieved through the API and also run a service each time a security log is stored. ![](https://cdn.document360.io/45e1a1b1-1964-46f1-939e-f40bde9b50fa/Images/Documentation/image-1738249463104.png) **Security Log Format - Player:** ```json { "ecs": { "version": string }, "@timestamp": string, "organization": { "name": string }, "user_agent": { "os": { "browser_language": string, "browser_platform": string, "is_mobile_device": bool, "is_verified_bot": bool }, "name": string, "device": { "name": string }, "original": string }, "os": { "family": string, "full": string }, "client": { "ip": string }, "event": { "action": string, "timezone": string }, "geo": { "country_name": string, "region_name": string }, "url": { "full": string, "domain": string }, "service": { "environment": string }, "label": { "app_type": string, "customer_id": string, "business_group": string, "business_group_id": string, "deploy_timestamp": string, "is_co_browsing_on": bool, "master_rid": string, "page_analytics_id": string, "page_index": string, "page_name": string, "process_id": string, "process_multi_language": string, "request_id": string, "rid": string, "role": string, "source_type": string, "source_value": string, "step_id": string, "step_index": string, "web_flow_name": string, "webflow_id": string, "player_version": string, "authentication_method": string, "authentication_status": string, "auth_action": string, "auth_page": string, } } ```