canvas_logs

Tables and types in canvas_logs namespace.

Tables in canvas_logs

web_logs

Stores the Canvas web application server access/request logs.

Logs include all interactions made with your instance of Canvas, therefore some interactions are done by users that are not present in the users table (originated from another institution). Note: Logs older than the retention limit of 30 days are no longer available via DAP API.

• Parameters:

  • id (UUID) – primary key The unique identifier for a logged web request.

  • timestamp (datetime) – Timestamp when the request was made in UTC.

  • user_id (canvas.users | None) – The unique ID of the user that made the request.

  • real_user_id (canvas.users | None) – If the request was processed by one user masquerading as another, then this column contains the real user ID of the user.

  • course_id (courses | None) – Course that owned the request.

  • quiz_id (quizzes | None) – Identifies the quiz if the request is for a quiz.

  • discussion_id (discussion_topics | None) – Identifies the discussion if the request is for a discussion.

  • conversation_id (conversations | None) – Identifies the conversation if the request is for a conversation.

  • assignment_id (assignments | None) – Identifies the assignment if the request is for an assignment.

  • url (str) – The path and the query string components of the requested URL.

  • user_agent_id (user_agents | None) – [DEPRECATED] This field previously served as a foreign key linking to the user_agent table. However, as of November 2023, user agent data is no longer loaded. Instead, user agent information is stored directly as a string in the user_agent field.

  • http_method (HTTPMethod) – HTTP method/verb (GET, POST, PUT, etc.) that was sent with the request.

  • http_status (HTTPStatus) – HTTP status code of the request (e.g. 200 OK).

  • http_version (HTTPVersion) – HTTP protocol version (e.g. HTTP/2.0).

  • remote_ip (IPv4Address | IPv6Address) – IP (IPv4 or IPv6) address that was recorded for the request.

  • interaction_micros (int32) – Total time required to service the request in microseconds.

  • web_application_controller (Controller | str | None) – The controller that the Canvas web application used to service this request.

  • web_application_action (Action | str | None) – The action in the Canvas web application used to service this request.

  • web_application_context_type (ContextType | None) – Containing object type that the Canvas web application used to service this request.

  • web_application_context_id (int64 | None) – Containing object ID that the Canvas web application used to service this request.

  • session_id (UUID | None) – ID of the user’s session where this request was made.

  • developer_key_id (developer_keys | None) – ID of the developer who accessed this resource if the request was made by a developer.

  • participated (bool) – Shows whether the HTTP request is considered a participation for the user.

  • user_agent (Literal [ '_dap_oversized_truncated_' ] | Annotated *[*str , MaxLength *(*255 ) ] | None) – The user agent string sent by the HTTP client.

user_agents

[DEPRECATED] This table previously stored user agent strings for the web_logs table. As of November 2023, this table is no longer loaded. User agent strings are now stored directly in the user_agent field within the web_logs table.

• Parameters:

  • id (int32) – primary key The unique identifier for a user agent.

  • http_user_agent (str | None) – The user agent string sent by the HTTP client.

Types in canvas_logs

HTTPVersion

Bases: Enum

HTTP protocol version.

http09 = '0.9'

http10 = '1.0'

http11 = '1.1'

http20 = '2.0'

ContextType

Bases: Enum

Web application context types.

account = 'Account'

assessment_question = 'AssessmentQuestion'

assignment = 'Assignment'

content_migration = 'ContentMigration'

course = 'Course'

course_section = 'CourseSection'

group = 'Group'

quiz_submission = 'Quizzes::QuizSubmission'

student_enrollment = 'StudentEnrollment'

user = 'User'

user_profile = 'UserProfile'

Action

Bases: Enum

Web application actions.

unspecified = '_dap_unspecified_'

Controller

Bases: Enum

Web application controllers.

unspecified = '_dap_unspecified_'

HTTPMethod

Bases: Enum

HTTP methods used in the Canvas API.

SEARCH = 'SEARCH'

PROPFIND = 'PROPFIND'

LOCK = 'LOCK'

REPORT = 'REPORT'

PURGE = 'PURGE'

MKCOL = 'MKCOL'

PROPPATCH = 'PROPPATCH'

CHECKOUT = 'CHECKOUT'

UNLOCK = 'UNLOCK'

MERGE = 'MERGE'

NOTIFY = 'NOTIFY'

MOVE = 'MOVE'

COPY = 'COPY'

UNSUBSCRIBE = 'UNSUBSCRIBE'

MKACTIVITY = 'MKACTIVITY'

SUBSCRIBE = 'SUBSCRIBE'

CONNECT = 'CONNECT'

DELETE = 'DELETE'

GET = 'GET'

HEAD = 'HEAD'

OPTIONS = 'OPTIONS'

PATCH = 'PATCH'

POST = 'POST'

PUT = 'PUT'

TRACE = 'TRACE'

HTTPStatus

Bases: Enum

CONTINUE = 100

SWITCHING_PROTOCOLS = 101

PROCESSING = 102

EARLY_HINTS = 103

OK = 200

CREATED = 201

ACCEPTED = 202

NON_AUTHORITATIVE_INFORMATION = 203

NO_CONTENT = 204

RESET_CONTENT = 205

PARTIAL_CONTENT = 206

MULTI_STATUS = 207

ALREADY_REPORTED = 208

IM_USED = 226

MULTIPLE_CHOICES = 300

MOVED_PERMANENTLY = 301

FOUND = 302

SEE_OTHER = 303

NOT_MODIFIED = 304

USE_PROXY = 305

TEMPORARY_REDIRECT = 307

PERMANENT_REDIRECT = 308

BAD_REQUEST = 400

UNAUTHORIZED = 401

PAYMENT_REQUIRED = 402

FORBIDDEN = 403

NOT_FOUND = 404

METHOD_NOT_ALLOWED = 405

NOT_ACCEPTABLE = 406

PROXY_AUTHENTICATION_REQUIRED = 407

REQUEST_TIMEOUT = 408

CONFLICT = 409

GONE = 410

LENGTH_REQUIRED = 411

PRECONDITION_FAILED = 412

CONTENT_TOO_LARGE = 413

URI_TOO_LONG = 414

UNSUPPORTED_MEDIA_TYPE = 415

RANGE_NOT_SATISFIABLE = 416

EXPECTATION_FAILED = 417

IM_A_TEAPOT = 418

MISDIRECTED_REQUEST = 421

UNPROCESSABLE_CONTENT = 422

LOCKED = 423

FAILED_DEPENDENCY = 424

TOO_EARLY = 425

UPGRADE_REQUIRED = 426

PRECONDITION_REQUIRED = 428

TOO_MANY_REQUESTS = 429

REQUEST_HEADER_FIELDS_TOO_LARGE = 431

UNAVAILABLE_FOR_LEGAL_REASONS = 451

INTERNAL_SERVER_ERROR = 500

NOT_IMPLEMENTED = 501

BAD_GATEWAY = 502

SERVICE_UNAVAILABLE = 503

GATEWAY_TIMEOUT = 504

HTTP_VERSION_NOT_SUPPORTED = 505

VARIANT_ALSO_NEGOTIATES = 506

INSUFFICIENT_STORAGE = 507

LOOP_DETECTED = 508

NOT_EXTENDED = 510

NETWORK_AUTHENTICATION_REQUIRED = 511