Versions Compared

Key

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

This article describes the types of CleverMaps audit log events, their descriptions, and a list of other event-specific parameters.

Audit log records are available on REST API and the API is designed for integration with SIEM systems. See more details about REST API in documentation.

The following parameters are common to all event types and are filled in for all events (if applicable):

  • accountId - user account identifier of an authenticated user

  • projectId - identifier of a project

  • timestamp - UTC timestamp of the event

  • eventId - unique identifier of the event

  • remote_host - IP address and a port of a client device

List of audit log events

Authentication and User account

...

Event type

...

Description

...

Additional parameters

...

request_access_token

...

Create a new access token for a refresh token

...

refresh_token

...

register_new_account

...

New user account registration

...

given_name, surname, email

...

change_password

...

Change password for authenticated user

...

email

...

delete_account

...

Remove an user account

...

email

...

reset_password_request

...

Accepted request to reset an user password

...

email

...

reset_password

...

User password reset

...

email, reset_password_account_id

Projects, members, invitations

...

Event type

...

Description

...

Additional parameters

...

create_project

...

A new project was created

...

project_title, created_project_id, org_id

...

update_project

...

Project was updated

...

project_title, project_status, org_id, services

...

delete_project

...

Project was deleted

...

create_membership

...

Add a new project member

...

created_account_id, role

...

update_membership

...

Update existing project member

...

updated_account_id, role, membership_status

...

delete_membership

...

Remove member from a project

...

deleted_account_id, role

...

accept_invitation

...

Accept a project invitation

...

invitation_hash, email

...

create_invitation

...

Create a new project invitation

...

invitation_id, email, role

...

update_invitation

...

Update existing project invitation

...

invitation_id, new_status

...

cancel_invitation

...

Cancel project invitation

...

invitation_id

...

Event type

...

Description

...

Additional parameters

...

search

...

Search query

...

search_query, datasets

...

geosearch

...

Geosearch query

...

search_query, country, language, types

DataWarehouse

...

Event type

...

Description

...

Additional parameters

...

dwh_query_accept

...

Accept DWH query

...

duration, cache_uri

...

dwh_query_exec

...

Execution DWH query

...

duration, cache_id

...

dwh_query_get_result

...

Get DWH query result

...

duration, cache_id, cache_type, page_number, page_size, items

...

dwh_metric_range_accept

...

Accept DWH metric range query

...

duration, cache_uri

...

dwh_metric_range_get_result

...

Get DWH metric range result

...

duration, cache_id

...

dwh_date_ranges_accept

...

Accept DWH date range query

...

date_ranges_request, cache_uri

...

dwh_date_ranges_get_result

...

Get DWH date range result

...

duration, cache_id

...

dwh_property_values_accept

...

Accept DWH values request

...

duration, cache_uri

...

dwh_property_values_get_result

...

Get DWH values result

...

duration, cache_id

...

dwh_metric_values_distribution

...

Accept metric values distribution query

...

duration, cache_uri

...

dwh_metric_values_distribution_get_result

...

Get metric values distribution query

...

duration, cache_id

...

dwh_values_distributions_accept

...

Accept DWH valuees distribution

...

duration, cache_uri

...

dwh_values_distributions_get_result

...

Get DWH valuees distribution result

...

duration, cache_id, null_cache_id

...

dwh_overlaps_accept

...

Accept DWH overlaps query

...

duration, cache_uri

...

dwh_overlaps_get_result

...

Get DWH overlaps query

...

duration, cache_id

...

dwh_data_get_dump

...

Download dumped CSV data

...

dump_id

Jobs

...

Event type

...

Description

...

Additional parameters

...

job_create_new

...

Start a new asynchronous job

...

type, execution_id

...

job_get_detail

...

Get job execution detail

...

type, execution_id

Export

...

Event type

...

Description

...

Additional parameters

...

export_get_result

...

Download exported CSV z S3

...

export_id, duration

Metadata

...

Event type

...

Description

...

Additional parameters

...

create_md_object

...

Create a new metadata object

...

type, id, md_object_name, md_object_title

...

update_md_object

...

Update existing metadata object

...

type, id, md_object_name, md_object_title

...

delete_md_object

...

Delete metadata object

...

type, id, md_object_name, md_object_title

Intercom

...

Event type

...

Description

...

Additional parameters

...

intercom_add_user

...

Add user to Intercom

...

user_id

...

intercom_delete_user

...

Remove user to Intercom

...

user_id

Asynchronous tasks

...

Event type

...

Description

...

Additional parameters

...

dataset_pull

...

Pull a new data to given dataset

...

dataset, mode, rows_loaded, org_id, dwh_cluster_id, total_rows, total_es_size, total_dwh_size

...

dataset_dump

...

Dump CSV data from a dataset

...

dataset, file_length, rows_dumped, org_id, dwh_cluster_id

...

validate

...

Validate project model and data

model_validator, data_validator

...

export

...

Execute DWH query and export result as CSV or XLS file

...

format, org_id, dwh_cluster_id

...

prepare_project

...

Prepare a new project

...

delete_project

...

Delete existing project

...

truncate_project

...

Truncate existing project

...

import_project

...

Import data and metadata into existing project

...

Panel
panelIconId1f389
panelIcon:tada:
panelIconText🎉
bgColor#E3FCEF

The content you are trying to reach has been moved here: https://docs.clevermaps.io/docs/audit-log-events

We are proud to announce that we have launched a new documentation.

Please update your saved links and bookmarks to follow a new address docs.clevermaps.io.