at_events.md

copyright	lastupdated	keywords	subcollection
years 2021	2021-03-12	IBM, activity tracker, LogDNA, event, security	discovery-data

{:external: target="_blank" .external} {:shortdesc: .shortdesc} {:table: .aria-labeledby="caption"} {:codeblock: .codeblock} {:tip: .tip} {:important: .important} {:note: .note}

Activity Tracker events

{: #at_events}

As a security officer, auditor, or manager, you can use the Activity Tracker service to track how users and applications interact with the {{site.data.keyword.discoveryshort}} service in {{site.data.keyword.cloud}}. {: shortdesc}

{{site.data.keyword.cloud_notm}} only

This information applies only to managed deployments. {: note}

{{site.data.keyword.at_full_notm}} records user-initiated activities that change the state of a service in {{site.data.keyword.cloud_notm}}. You can use this service to investigate abnormal activity and critical actions and to comply with regulatory audit requirements. In addition, you can be alerted about actions as they happen. The events that are collected comply with the Cloud Auditing Data Federation (CADF) standard. For more information, see the getting started tutorial for {{site.data.keyword.at_full_notm}}{: external}.

List of events

{: #at_actions}

The following table lists the {{site.data.keyword.discoveryshort}} actions that generate an event.

Action	Description
discovery.document.create	Create a document
discovery.document.add	Add one document
discovery.document.update	Update one document by ingesting new or modified content for a document, given a document ID, or by changing the label for a given document ID
discovery.document.read	Download a PDF version of a document
discovery.document.delete	Delete document by ID
discovery.query.read	Search a collection for relevant documents
discovery.notices.read	Get notices for a collection
discovery.fields.read	Get fields for a collection
discovery.logs.read	Get logs for a collection
discovery.training-data.read	Request all training data
discovery.training-data.delete	Delete the training data
discovery.training-query.create	Add a query to the training data
discovery.training-query.delete	Delete a query from the training data
discovery.training-query.read	Read the contents of a query
discovery.training-example.create	Add an example to a query in the training data
discovery.training-example.update	Update an example of a query in the training data
discovery.training-example.delete	Delete an example from a query in the training data
discovery.training-example.read	Read the contents of a training example
discovery.training-examples.read	Read the contents of all examples in a query
discovery.collection-training-status.read	Get the training status of a single-collection training
discovery.multi-collection-training-status.read	Get the training status of a multi-collection training
discovery.metric.read	Request a metric
discovery.event.create	Add a click event to a query
discovery.credential.create	Create a credential
discovery.credential.update	Update a credential
discovery.credential.delete	Delete a credential
discovery.credential.read	Get a credential, Salesforce obects, or a list of Cloud Object Storage buckets
discovery.dataset.create	Create a data set
discovery.dataset.update	Update a data set
discovery.curations.create	Create a curated query
discovery.curations.read	List currently configured curation queries
discovery.curations.update	Update existing curated results documents for a specified query
discovery.curations.delete	Delete specified curation
discovery.dictionary.create	Create a dictionary
discovery.dictionary.read	Read a dictionary
discovery.dictionary.update	Update a dictionary
discovery.dictionary.delete	Delete a dictionary
discovery.user-data.delete	Delete all data associated with specified customer ID
discovery.collections.read	Read collection annotations
discovery.label.read	Read a collection label
discovery.label.create	Create a collection label
discovery.label.delete	Delete one or multiple documents from one or multiple collections based on a label
discovery.label.update	Update a collection label
discovery.document-annotation.read	Read document annotations
discovery.page.read	Read document pages
discovery.page-prediction.read	Read document page predictions
discovery.table-annotation.read	Read document page table annotations
discovery.table-cell.read	Read document page table cell
discovery.page-annotation.add	Add document page annotation
discovery.page-view.read	Read document page view
discovery.model.export	Export model
discovery.model.import	Import model
discovery.content-miner-export.create	Create a set of exported documents from Content Miner
discovery.content-miner-export.search	List sets of exported documents from Content Miner
discovery.content-miner-export.download	Download exported documents from Content Miner
discovery.content-miner-report.create	Create a report from Content Miner
discovery.content-miner-report.read	Get report content from Content Miner
discovery.content-miner-report.update	Update report content from Content Miner
discovery.content-miner-report.delete	Delete a report from Content Miner
discovery.content-miner-csv.create	Import a CSV file from Content Miner
discovery.content-miner-csv.read	Get a CSV file from Content Miner
discovery.content-miner-csv.delete	Delete a CSV file from Content Miner
discovery.document-results.read	Search collection(s) for relevant documents
discovery.autocompletion.read	Suggest complete queries based on documents
discovery.collection-notices.read	Get notices for a collection
discovery.project-notices.read	Get notices for a project
discovery.dataset-notices.read	Get notices for a data set
discovery.project.create	Create a project
discovery.project.delete	Delete a project
discovery.stopwords.create	Add stopwords to a collection
discovery.stopwords.read	Get stopwords for a collection
discovery.stopwords.delete	Delete stopwords from a collection
discovery.expansions.create	Add synonyms to a collection
discovery.expansions.read	Get synonyms for a collection
discovery.expansions.delete	Delete synonyms from a collection
{: caption="Table 1. Actions that generate events" caption-side="top"}

Viewing events

{: #at_ui}

Events that are generated by an instance of the {{site.data.keyword.discoveryshort}} service are automatically forwarded to the {{site.data.keyword.at_full_notm}} service instance that is available in the same location.

{{site.data.keyword.at_full_notm}} can have only one instance per location. To view events, you must access the web UI of the {{site.data.keyword.at_full_notm}} service in the same location where your service instance is available. For more information, see Navigating to the LogDNA web UI{: external}.