Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
toc

Managing Logs

Info

Logs are actions triggered in CRM.COM provides the ability to display all by either a Contact using a front-end device, a system user from the back-end system, an integrator or a system process.

Log files can be viewed and analysed; they contain technical and processing information regarding a particular event that has occur. Details regarding associated with an event which has occurred in the system. Details relating to the specific occurrence of an event are also logged - in terms of failure or pass status successful/unsuccessful completion, as well as information specific to executing the occurrence event - in the form of API requests and responses responsible for executing an event.

API logs are displayed on the crm application

.

To view logs Logs navigate to Platform > logs from the main menu on the left-hand - side of the screen.

On this screen one will be able to view the following:

Image Removed
  • the status of the response API.

  • the method call of the api

    Image Added

    By default, only today’s logs are displayed. Apply a filter to view logs submitted within a different time frame.

    The summary Log screen provides basic details of the Log, i.e.

    • The status of the API response

    • The call method of the API (POST/PUT).the API url.

    • The actual API URL endpoint

    • The date that the event correlating to this log occuredoccurred

    Select a Log to see its details.

    Log Details

    Image Removed

    Viewing a Log

    When a Log entry is selected, additional information is provided.

    Image Added

    The following content is displayed in the detailed log view:

    • status: the status relating to the response of Status - Indicates whether the API request response was successful or not.source : the url

    • Source - The URL associated with the API call .

    • ID : the - The unique API ID .

    • submitted date: the date Submitted Date - The date and time that the API request was submitted .

    • IP Address: the - The IP address from where the request was submitted .

    • API version: the - The specific version of this the API .

    • Request and Sent / Response : Received - The exact API request and response that was submitted and returned .

    Settings

    None.

    Reference Material

    You may also find it useful to refer to the following manuals for further reading in relation to Logs.

    Events

    .

    TABLE OF CONTENTS
    Table of Contents
    maxLevel6
    minLevel1
    outlinefalse
    typelist
    printablefalse