Instructure Developer Documentation Portal
Community
  • Introduction
  • Services
    • Elevate Standards Alignment - AB Connect API
      • Introduction
        • Authentication
        • Addressing Object Properties
        • Requesting Additional Properties in the Response
        • Filtering Using ODATA Like Statements
        • Sorting
        • Facets
        • Paging Data
        • Call Throttling
        • Working with Related Object
        • Error Responses
        • Character Set Support
        • How To Articles, Recommendations and Suggestions
        • Examples
        • Using AB Connect's Embeddable Widgets
      • Reference
        • Standards
        • Standard Collections
        • Events
        • Topics
        • Concepts
        • Assets
        • Asset Definitions
        • Asset Collections
        • Managing and Predicting Relationships
        • Providers
    • Canvas LMS
      • Basics
        • GraphQL
        • API Change Log
        • SIS IDs
        • Pagination
        • Throttling
        • Compound Documents
        • File Uploads
        • API Endpoint Attributes
        • Masquerading
      • OAuth2
        • OAuth2 Overview
        • OAuth2 Endpoints
        • Developer Keys
      • Resources
        • Access Tokens
        • Account Calendars
        • Account Domain Lookups
        • Account Notifications
        • Account Reports
        • Accounts
        • Accounts (LTI)
        • Admins
        • Analytics
        • Announcement External Feeds
        • Announcements
        • API Token Scopes
        • Appointment Groups
        • Assignment Extensions
        • Assignment Groups
        • Assignments
        • Authentication Providers
        • Authentications Log
        • Blackout Dates
        • BlockEditorTemplate
        • Blueprint Courses
        • Bookmarks
        • Brand Configs
        • Calendar Events
        • Collaborations
        • CommMessages
        • Communication Channels
        • Conferences
        • Content Exports
        • Content Migrations
        • Content Security Policy Settings
        • Content Shares
        • Conversations
        • Course Audit log
        • Course Pace
        • Course Quiz Extensions
        • Course Reports
        • Courses
        • Custom Gradebook Columns
        • Developer Key Account Bindings
        • Developer Keys
        • Discussion Topics
        • Enrollment Terms
        • Enrollments
        • ePortfolios
        • ePub Exports
        • Error Reports
        • External Tools
        • Favorites
        • Feature Flags
        • Files
        • Grade Change Log
        • Gradebook History
        • Grading Period Sets
        • Grading Periods
        • Grading Standards
        • Group Categories
        • Groups
        • History
        • InstAccess tokens
        • JWTs
        • Late Policy
        • Learning Object Dates
        • Line Items
        • LiveAssessments
        • Logins
        • LTI Launch Definitions
        • LTI Registrations
        • LTI Resource Links
        • Media Objects
        • Moderated Grading
        • Modules
        • Names and Role
        • New Quiz Items
        • New Quizzes
        • New Quizzes Accommodations
        • New Quizzes Reports
        • Notification Preferences
        • Originality Reports
        • Outcome Groups
        • Outcome Imports
        • Outcome Results
        • Outcomes
        • Pages
        • Peer Reviews
        • Planner
        • Poll Sessions
        • PollChoices
        • Polls
        • PollSubmissions
        • Proficiency Ratings
        • Progress
        • Public JWK
        • Quiz Assignment Overrides
        • Quiz Extensions
        • Quiz IP Filters
        • Quiz Question Groups
        • Quiz Questions
        • Quiz Reports
        • Quiz Statistics
        • Quiz Submission Events
        • Quiz Submission Files
        • Quiz Submission Questions
        • Quiz Submission User List
        • Quiz Submissions
        • Quizzes
        • Result
        • Roles
        • Rubrics
        • Sandboxes
        • Score
        • Search
        • Sections
        • Services
        • Shared Brand Configs
        • SIS Import Errors
        • SIS Imports
        • SIS Integration
        • Smart Search
        • Submission Comments
        • Submissions
        • Tabs
        • Temporary Enrollment Pairings
        • User Observees
        • Users
        • What If Grades
      • Outcomes
        • Outcomes CSV Format
      • Group Categories
        • Group Categories CSV Format
      • SIS
        • SIS CSV Format
      • External Tools
        • LTI
          • Introduction
          • Registration
          • Launch Overview
          • Configuring
          • Variable Substitutions
          • Deep Linking
          • Grading
          • Provisioning
          • PostMessage
          • Platform Notification Service
          • Placements
            • Placements Overview
            • Navigation
            • Homework Submission
            • Editor Button
            • Migration Selection
            • Link Selection (Modules)
            • Assignment Selection
            • Collaborations
        • xAPI
        • Canvas Roles
        • Plagiarism Detection Platform
          • Overview
          • Plagiarism Detection Platform Assignments
          • Plagiarism Detection Platform Users
          • Plagiarism Detection Submissions
          • Webhooks Subscriptions for Plagiarism Platform
          • JWT Access Tokens
      • Data Services
        • Live Events
          • Overview
            • Introduction
            • Setup
            • Caliper
            • Metadata
          • Event Format
            • Canvas
              • Account
              • Asset
              • Assignment
              • Attachment
              • Content
              • Conversation
              • Course
              • Discussion
              • Enrollment
              • Grade
              • Group
              • Learning
              • Logged
              • Module
              • Outcome
              • Outcomes
              • Plagiarism
              • Quiz
              • Rubric
              • Sis
              • Submission
              • Syllabus
              • User
              • Wiki
            • Caliper IMS 1.1
              • Assessment
              • Basic
              • Forum
              • Grading
              • Navigation Events
              • Session
    • Catalog
      • APIs
        • Analytics
        • Bulk Enrollments
        • Catalogs
        • Certificates
        • Completed Certificates
        • Courses
        • Email Domain Set
        • Enrollments
        • Orders
        • Programs
        • Progresses
        • Tags
        • User Registrations
        • Users
        • Waitlist Applicants
    • Credentials
      • Getting Started
      • Authentication
        • Password-Based Authentication
        • Authorization Code-Based Authentication
      • Pagination
      • APIs
        • Assertions
        • Backpack
        • Badgeclasses
        • Issuers
        • Organizations
        • Users
      • Release Notes
    • Data Access Platform
      • Key Concepts
      • Data Formats
      • Rate Limits & Policies
      • Datasets
        • Namespaces
          • canvas
            • canvas types
          • canvas_logs
          • catalog
        • Additional Notes
        • Entity Relationship Diagram
      • Query API
        • Authentication
        • Reference
      • Command Line (DAP CLI)
        • Getting Started
        • Secure Connection
        • Reference
          • dap snapshot
          • dap incremental
          • dap list
          • dap schema
          • dap initdb
          • dap syncdb
          • dap dropdb
      • Client Library
        • Examples
        • Reference
      • Release Notes
      • Status
    • DataSync
      • Interop API
      • Interop Data API
      • Grades Exchange API
      • OneRoster API
      • Platform API
    • Instructure Media
      • API Reference
        • Captions
        • Collection
        • Courses
        • Group
        • Insights
        • Media
        • Media Upload
        • Ping
        • Professional Captioning
        • Tags
        • Transfer Media
        • User
    • Quizzes
      • Quiz API
Powered by GitBook

Copyright © 2008-2024 Instructure, Inc. All rights reserved. Various trademarks held by their respective owners.

On this page
  • Tables in canvas_logs
  • web_logs
  • Types in canvas_logs
  • HTTPVersion
  • ContextType
  • Action
  • Controller
  • HTTPMethod
  • HTTPStatus

Was this helpful?

  1. Services
  2. Data Access Platform
  3. Datasets
  4. Namespaces

canvas_logs

Tables and types in canvas_logs namespace.

Previouscanvas typesNextcatalog

Last updated 4 months ago

Was this helpful?

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 ( | None) – The unique ID of the user that made the request.

    • real_user_id ( | 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 ( | None) – Course that owned the request.

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

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

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

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

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

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

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

    • http_version () – 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 ( | str | None) – The controller that the Canvas web application used to service this request.

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

    • web_application_context_type ( | 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 ( | 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.

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

HTTPMethod
HTTPStatus
HTTPVersion
Controller
Action
ContextType
canvas.users
canvas.users
courses
quizzes
discussion_topics
conversations
assignments
developer_keys