client.usage.list_matching

A method of the Usage endpoint.

list_matching(*, org_id: int = None, task: str = None, start_date: str = None, end_date: str = None) → ListResponse

Get usage statistics for a given organization

API URL: GET /usage/matching

import civis
client = civis.APIClient()
response = client.usage.list_matching(...)

Parameters:

org_idint, optional

The ID of the organization to get usage statistics for.

taskstr, optional

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

start_datestr, optional

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

end_datestr, optional

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

Returns:

civis.ListResponse

• run_idint

  The ID of the run which contributed this usage.

• job_idint

  The ID of the job which contributed this usage.

• user_idint

  The ID of the user who contributed this usage.

• organization_idint

  The organization of the user who contributed this usage.

• run_created_atstr (date-time)

  When the run was created at.

• run_timeint

  The duration of the run in seconds.

• num_recordsint

  The number of records matched by the run.

• taskstr

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