@spec create_monitor(map()) :: {:ok, map()} | {:error, any()}

Create a Brand Exposure monitor.

Parameters

• body: Monitor creation request body
  • :name — Monitor name
  • :targets — List of target domains
  • :labels — List of labels
  • :frequency — Scan frequency
  • :impact — Impact level
  • Additional optional fields

Examples

{:ok, monitor} = Intel471Ex.BrandExposure.create_monitor(%{
  name: "example.com",
  targets: ["example.com"],
  labels: ["brand-monitor"],
  frequency: "daily",
  impact: "major"
})

@spec delete_monitor(String.t()) :: {:ok, map()} | {:error, any()}

Delete a Brand Exposure monitor by ID.

Examples

{:ok, _} = Intel471Ex.BrandExposure.delete_monitor("monitor-id")

@spec edit_monitor(String.t(), map()) :: {:ok, map()} | {:error, any()}

Edit a Brand Exposure monitor.

Parameters

• id: Monitor ID
• body: Updated monitor fields

Examples

{:ok, _} = Intel471Ex.BrandExposure.edit_monitor("monitor-id", %{name: "updated-name"})

@spec get_config_current(String.t()) :: {:ok, map()} | {:error, any()}

Get the current configuration for a section.

Examples

{:ok, config} = Intel471Ex.BrandExposure.get_config_current("general")

@spec get_config_defaults(String.t()) :: {:ok, map()} | {:error, any()}

Get the default configuration for a section.

Examples

{:ok, defaults} = Intel471Ex.BrandExposure.get_config_defaults("general")

@spec get_config_schema() :: {:ok, map()} | {:error, any()}

Get the configuration schema.

Examples

{:ok, schema} = Intel471Ex.BrandExposure.get_config_schema()

@spec get_config_user(String.t()) :: {:ok, map()} | {:error, any()}

Get the user configuration for a section.

Examples

{:ok, user_config} = Intel471Ex.BrandExposure.get_config_user("general")

@spec get_monitor(String.t()) :: {:ok, map()} | {:error, any()}

Get a Brand Exposure monitor by ID.

Examples

{:ok, monitor} = Intel471Ex.BrandExposure.get_monitor("monitor-id")

@spec get_monitor_logs(String.t(), map()) :: {:ok, map()} | {:error, any()}

Get monitor logs.

Parameters

• id: Monitor ID
• params: Query parameters (:limit, :log_type, :search_text, :cursor, :backward)

Examples

{:ok, logs} = Intel471Ex.BrandExposure.get_monitor_logs("monitor-id")
{:ok, logs} = Intel471Ex.BrandExposure.get_monitor_logs("monitor-id", %{limit: 50, log_type: "scan"})

@spec get_monitor_scans(String.t(), map()) :: {:ok, map()} | {:error, any()}

Get scans for a Brand Exposure monitor.

Parameters

• id: Monitor ID
• params: Query parameters (:status filter)

Examples

{:ok, scans} = Intel471Ex.BrandExposure.get_monitor_scans("monitor-id")
{:ok, scans} = Intel471Ex.BrandExposure.get_monitor_scans("monitor-id", %{status: "completed"})

@spec get_scan_data(String.t(), map()) :: {:ok, map()} | {:error, any()}

Get scan data for a Brand Exposure scan.

Parameters

• scan_id: Scan ID
• params: Query parameters (:category, :type, :source, :annotated, :starred, :text, :sort, :descending, :limit, :cursor, :backward)

Deprecated in the Brand Exposure API.

Examples

{:ok, data} = Intel471Ex.BrandExposure.get_scan_data("scan-id")
{:ok, data} = Intel471Ex.BrandExposure.get_scan_data("scan-id", %{category: "domain", limit: 50})

@spec get_scan_data_element(String.t(), String.t()) :: {:ok, map()} | {:error, any()}

Get a specific scan data element.

Deprecated in the Brand Exposure API.

Examples

{:ok, element} = Intel471Ex.BrandExposure.get_scan_data_element("scan-id", "element-id")

@spec get_scan_data_element_children(String.t(), String.t()) ::
  {:ok, map()} | {:error, any()}

Get children of a scan data element.

Deprecated in the Brand Exposure API.

Examples

{:ok, children} = Intel471Ex.BrandExposure.get_scan_data_element_children("scan-id", "element-id")

@spec get_scan_data_element_discovery(String.t(), String.t()) ::
  {:ok, map()} | {:error, any()}

Get discovery data for a scan data element.

Deprecated in the Brand Exposure API.

Examples

{:ok, discovery} = Intel471Ex.BrandExposure.get_scan_data_element_discovery("scan-id", "element-id")

@spec get_scan_data_element_events(String.t(), String.t()) ::
  {:ok, map()} | {:error, any()}

Get events for a scan data element.

Deprecated in the Brand Exposure API.

Examples

{:ok, events} = Intel471Ex.BrandExposure.get_scan_data_element_events("scan-id", "element-id")

@spec get_scan_data_element_relationships(String.t(), String.t()) ::
  {:ok, map()} | {:error, any()}

Get relationships for a scan data element.

Deprecated in the Brand Exposure API.

Examples

{:ok, rels} = Intel471Ex.BrandExposure.get_scan_data_element_relationships("scan-id", "element-id")

@spec get_scan_data_graph(String.t(), map()) :: {:ok, map()} | {:error, any()}

Get scan data graph for a Brand Exposure scan.

Deprecated in the Brand Exposure API.

Examples

{:ok, graph} = Intel471Ex.BrandExposure.get_scan_data_graph("scan-id")

@spec get_scan_data_tree(String.t(), map()) :: {:ok, map()} | {:error, any()}

Get scan data tree for a Brand Exposure scan.

Deprecated in the Brand Exposure API.

Examples

{:ok, tree} = Intel471Ex.BrandExposure.get_scan_data_tree("scan-id")

@spec list_monitors(map()) :: {:ok, map()} | {:error, any()}

List Brand Exposure monitors.

Parameters

• params: A map of query parameters
  • :last_run_after / :last_run_before — Filter by last run time

Examples

{:ok, monitors} = Intel471Ex.BrandExposure.list_monitors()

@spec patch_scan_data_element(String.t(), String.t(), map()) ::
  {:ok, map()} | {:error, any()}

Patch a scan data element.

Deprecated in the Brand Exposure API.

Examples

{:ok, _} = Intel471Ex.BrandExposure.patch_scan_data_element("scan-id", "element-id", %{starred: true})

@spec put_config_user(String.t(), map()) :: {:ok, map()} | {:error, any()}

Update the user configuration for a section.

Examples

{:ok, _} = Intel471Ex.BrandExposure.put_config_user("general", %{key: "value"})

@spec run_monitor(String.t(), map() | nil) :: {:ok, map()} | {:error, any()}

Run a Brand Exposure monitor.

Parameters

• id: Monitor ID
• body: Optional body with :at timestamp

Examples

{:ok, _} = Intel471Ex.BrandExposure.run_monitor("monitor-id")
{:ok, _} = Intel471Ex.BrandExposure.run_monitor("monitor-id", %{at: "2026-01-01T00:00:00Z"})