EventsApi class reference

All URIs are relative tohttp://localhost

MethodHTTP requestDescription
createPOST /api/eventsLog client events
create_exportPOST /api/events/exportInitiate a process to export events
listGET /api/eventsGet an event log

create

create(client_events_request,x_organization=None,org=None,org_id=None,**kwargs)

Log client events

Sends logs to the Clickhouse if it is connected

Example

frompprintimportpprintfromcvat_sdk.api_clientimportConfiguration,ApiClient,exceptionsfromcvat_sdk.api_client.modelsimport*# Set up an API client# Read Configuration class docs for more info about parameters and authentication methodsconfiguration=Configuration(host="http://localhost",username='YOUR_USERNAME',password='YOUR_PASSWORD',)withApiClient(configuration)asapi_client:client_events_request=ClientEventsRequest(events=[EventRequest(scope="scope_example",obj_name="obj_name_example",obj_id=1,obj_val="obj_val_example",source="source_example",timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'),count=1,duration=0,project_id=1,task_id=1,job_id=1,user_id=1,user_name="user_name_example",user_email="user_email_example",org_id=1,org_slug="org_slug_example",payload="payload_example",),],previous_event=ClientEventsRequestPreviousEvent(None),timestamp=dateutil_parser('1970-01-01T00:00:00.00Z'),)# ClientEventsRequest |x_organization="X-Organization_example"# str | Organization unique slug (optional)org="org_example"# str | Organization unique slug (optional)org_id=1# int | Organization identifier (optional)try:(data,response)=api_client.events_api.create(client_events_request,x_organization=x_organization,org=org,org_id=org_id,)pprint(data)exceptexceptions.ApiExceptionase:print("Exception when calling EventsApi.create():%s\n"%e)

Parameters

NameTypeDescriptionNotes
client_events_requestClientEventsRequest
x_organizationstrOrganization unique slug[optional]
orgstrOrganization unique slug[optional]
org_idintOrganization identifier[optional]

There are also optional kwargs that control the function invocation behavior.Read more here.

Returned values

Returned type:Tuple[ClientEvents, urllib3.HTTPResponse].

Returns a tuple with 2 values:(parsed_response, raw_response).

The first value is a model parsed from the response data.The second value is the raw response, which can be useful to get response parameters, such asstatus code, headers, or raw response data. Read more about invocation parametersand returned valueshere.

Authentication

basicAuth, csrfAuth, csrfHeaderAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/vnd.cvat+json

HTTP response details

Status codeDescriptionResponse headers
201-

create_export

create_export(cloud_storage_id=None,filename=None,_from=None,job_id=None,location=None,org_id=None,project_id=None,task_id=None,to=None,user_id=None,**kwargs)

Initiate a process to export events

Example

frompprintimportpprintfromcvat_sdk.api_clientimportConfiguration,ApiClient,exceptionsfromcvat_sdk.api_client.modelsimport*# Set up an API client# Read Configuration class docs for more info about parameters and authentication methodsconfiguration=Configuration(host="http://localhost",username='YOUR_USERNAME',password='YOUR_PASSWORD',)withApiClient(configuration)asapi_client:cloud_storage_id=1# int | Storage id (optional)filename="filename_example"# str | Desired output file name (optional)_from=dateutil_parser('1970-01-01T00:00:00.00Z')# datetime | UTC start date for events filtration. Default is the minimal time. (optional)job_id=1# int | Filter events by job ID (optional)location="cloud_storage"# str | Where need to save events file (optional)org_id=1# int | Filter events by organization ID (optional)project_id=1# int | Filter events by project ID (optional)task_id=1# int | Filter events by task ID (optional)to=dateutil_parser('1970-01-01T00:00:00.00Z')# datetime | UTC end date for events filtration. Default is the current time. (optional)user_id=1# int | Filter events by user ID (optional)try:(data,response)=api_client.events_api.create_export(cloud_storage_id=cloud_storage_id,filename=filename,_from=_from,job_id=job_id,location=location,org_id=org_id,project_id=project_id,task_id=task_id,to=to,user_id=user_id,)pprint(data)exceptexceptions.ApiExceptionase:print("Exception when calling EventsApi.create_export():%s\n"%e)

Parameters

NameTypeDescriptionNotes
cloud_storage_idintStorage id[optional]
filenamestrDesired output file name[optional]
_fromdatetimeUTC start date for events filtration. Default is the minimal time.[optional]
job_idintFilter events by job ID[optional]
locationstrWhere need to save events file[optional]
org_idintFilter events by organization ID[optional]
project_idintFilter events by project ID[optional]
task_idintFilter events by task ID[optional]
todatetimeUTC end date for events filtration. Default is the current time.[optional]
user_idintFilter events by user ID[optional]

There are also optional kwargs that control the function invocation behavior.Read more here.

Returned values

Returned type:Tuple[RqId, urllib3.HTTPResponse].

Returns a tuple with 2 values:(parsed_response, raw_response).

The first value is a model parsed from the response data.The second value is the raw response, which can be useful to get response parameters, such asstatus code, headers, or raw response data. Read more about invocation parametersand returned valueshere.

Authentication

basicAuth, csrfAuth, csrfHeaderAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/vnd.cvat+json

HTTP response details

Status codeDescriptionResponse headers
202-

list

list(action=None,filename=None,_from=None,job_id=None,org_id=None,project_id=None,query_id=None,task_id=None,to=None,user_id=None,**kwargs)

Get an event log

The log is returned in the CSV format.

Example

frompprintimportpprintfromcvat_sdk.api_clientimportConfiguration,ApiClient,exceptionsfromcvat_sdk.api_client.modelsimport*# Set up an API client# Read Configuration class docs for more info about parameters and authentication methodsconfiguration=Configuration(host="http://localhost",username='YOUR_USERNAME',password='YOUR_PASSWORD',)withApiClient(configuration)asapi_client:action="download"# str | Used to start downloading process after annotation file had been created (optional) if omitted the server will use the default value of "download"filename="filename_example"# str | Desired output file name (optional)_from=dateutil_parser('1970-01-01T00:00:00.00Z')# datetime | UTC start date for events filtration. Default is the minimal time. (optional)job_id=1# int | Filter events by job ID (optional)org_id=1# int | Filter events by organization ID (optional)project_id=1# int | Filter events by project ID (optional)query_id="query_id_example"# str | ID of query request that need to check or download (optional)task_id=1# int | Filter events by task ID (optional)to=dateutil_parser('1970-01-01T00:00:00.00Z')# datetime | UTC end date for events filtration. Default is the current time. (optional)user_id=1# int | Filter events by user ID (optional)try:api_client.events_api.list(action=action,filename=filename,_from=_from,job_id=job_id,org_id=org_id,project_id=project_id,query_id=query_id,task_id=task_id,to=to,user_id=user_id,)exceptexceptions.ApiExceptionase:print("Exception when calling EventsApi.list():%s\n"%e)

Parameters

NameTypeDescriptionNotes
actionstrUsed to start downloading process after annotation file had been created[optional] if omitted the server will use the default value of “download”
filenamestrDesired output file name[optional]
_fromdatetimeUTC start date for events filtration. Default is the minimal time.[optional]
job_idintFilter events by job ID[optional]
org_idintFilter events by organization ID[optional]
project_idintFilter events by project ID[optional]
query_idstrID of query request that need to check or download[optional]
task_idintFilter events by task ID[optional]
todatetimeUTC end date for events filtration. Default is the current time.[optional]
user_idintFilter events by user ID[optional]

There are also optional kwargs that control the function invocation behavior.Read more here.

Returned values

Returned type:Tuple[None, urllib3.HTTPResponse].

Returns a tuple with 2 values:(None, raw_response).

This endpoint does not have any return value, soNone is always returned as the first value.The second value is the raw response, which can be useful to get response parameters, such asstatus code, headers, or raw response data. Read more about invocation parametersand returned valueshere.

Authentication

basicAuth, csrfAuth, csrfHeaderAuth, sessionAuth, signatureAuth, tokenAuth

HTTP request headers

  • Content-Type: Not defined
  • Accept: Not defined

HTTP response details

Status codeDescriptionResponse headers
200Download of file started-
201CSV log file is ready for downloading-
202Creating a CSV log file has been started-