civis (version 3.1.3)

usage_list_matching: Get usage statistics for a given organization

Description

Get usage statistics for a given organization

Usage

usage_list_matching(
  org_id = NULL,
  task = NULL,
  start_date = NULL,
  end_date = NULL
)

Value

An array containing the following fields:

runId

integer, The ID of the run which contributed this usage.

jobId

integer, The ID of the job which contributed this usage.

userId

integer, The ID of the user who contributed this usage.

organizationId

integer, The organization of the user who contributed this usage.

runCreatedAt

string, When the run was created at.

runTime

integer, The duration of the run in seconds.

numRecords

integer, The number of records matched by the run.

task

string, The type of matching job contributing to this usage. One of ["IDR", "CDM"].

Arguments

org_id

integer optional. The ID of the organization to get usage statistics for.

task

string optional. The type of matching job contributing to this usage. One of ["IDR", "CDM"].

start_date

string optional. The start date of the range to get usage statistics for.

end_date

string optional. The end date of the range to get usage statistics for.