Skip to contents

Retrieve investigation records from the telemetry API. All filter parameters are optional; omit them to return all investigations.

Usage

dep_read_investigations(
  id = NULL,
  status = NULL,
  type = NULL,
  department = NULL,
  title = NULL,
  started_at = NULL,
  finished_at = NULL,
  includes = NULL,
  page_args = list(),
  dry_run = FALSE,
  verbosity = 0
)

Arguments

id

Integer vector. Filter by investigation ID(s).

status

Character vector. Filter by investigation status.

type

Character. Filter by investigation type.

department

Character. Filter by department.

title

Character. Filter by title (partial match).

started_at

Character. Filter by start date (e.g. "2024-01-01,2024-12-31" for a range).

finished_at

Character. Filter by finish date (same range format).

includes

Character vector of related resources to include in the response. Valid values: "calls", "investigations", "animals", "group".

page_args

List of pagination arguments passed to spdgt.auth::api_get().

dry_run

Logical. If TRUE, prints the request without sending it.

verbosity

Integer. How much information to print (0 = silent, 1 = headers, 2 = headers + body, 3 = full).

Value

A tibble of investigation records.