Skip to Content
Odoo Menu
  • Sign in
  • Try it free
  • Apps
    Finance
    • Accounting
    • Invoicing
    • Expenses
    • Spreadsheet (BI)
    • Documents
    • Sign
    Sales
    • CRM
    • Sales
    • POS Shop
    • POS Restaurant
    • Subscriptions
    • Rental
    Websites
    • Website Builder
    • eCommerce
    • Blog
    • Forum
    • Live Chat
    • eLearning
    Supply Chain
    • Inventory
    • Manufacturing
    • PLM
    • Purchase
    • Maintenance
    • Quality
    Human Resources
    • Employees
    • Recruitment
    • Time Off
    • Appraisals
    • Referrals
    • Fleet
    Marketing
    • Social Marketing
    • Email Marketing
    • SMS Marketing
    • Events
    • Marketing Automation
    • Surveys
    Services
    • Project
    • Timesheets
    • Field Service
    • Helpdesk
    • Planning
    • Appointments
    Productivity
    • Discuss
    • Artificial Intelligence
    • IoT
    • VoIP
    • Knowledge
    • WhatsApp
    Third party apps Odoo Studio Odoo Cloud Platform
  • Industries
    Retail
    • Book Store
    • Clothing Store
    • Furniture Store
    • Grocery Store
    • Hardware Store
    • Toy Store
    Food & Hospitality
    • Bar and Pub
    • Restaurant
    • Fast Food
    • Guest House
    • Beverage Distributor
    • Hotel
    Real Estate
    • Real Estate Agency
    • Architecture Firm
    • Construction
    • Property Management
    • Gardening
    • Property Owner Association
    Consulting
    • Accounting Firm
    • Odoo Partner
    • Marketing Agency
    • Law firm
    • Talent Acquisition
    • Audit & Certification
    Manufacturing
    • Textile
    • Metal
    • Furnitures
    • Food
    • Brewery
    • Corporate Gifts
    Health & Fitness
    • Sports Club
    • Eyewear Store
    • Fitness Center
    • Wellness Practitioners
    • Pharmacy
    • Hair Salon
    Trades
    • Handyman
    • IT Hardware & Support
    • Solar Energy Systems
    • Shoe Maker
    • Cleaning Services
    • HVAC Services
    Others
    • Nonprofit Organization
    • Environmental Agency
    • Billboard Rental
    • Photography
    • Bike Leasing
    • Software Reseller
    Browse all Industries ⟶
  • Community
    Learn
    • Tutorials
    • Documentation
    • Certifications
    • Training
    • Blog
    • Podcast
    Empower Education
    • Education Program
    • Scale Up! Business Game
    • Visit Odoo
    Get the Software
    • Download
    • Compare Editions
    • Releases
    Collaborate
    • Github
    • Forum
    • Events
    • Translations
    • Become a Partner
    • Services for Partners
    • Register your Accounting Firm
    • Affiliate Program
    Get Services
    • Find a Partner
    • Find an Accountant
      • Get a Tailored Demo
    • Implementation Services
    • Customer References
    • Support
    • Upgrades
    Github Youtube Twitter Linkedin Instagram Facebook Spotify
    +32 2 290 34 90
    • Get a Tailored Demo
  • Pricing
  • Help
  1. APPS
  2. Technical
  3. API Request Logger v 17.0
  4. Sales Conditions FAQ

API Request Logger

by Viindoo https://viindoo.com/apps/modules/19.0/viin_api_request_logger
Odoo

$ 30.15

v 17.0 Third Party 1
Live Preview
Apps purchases are linked to your Odoo account, please sign in or sign up first.
Versions 17.0 18.0 19.0
You bought this module and need support? Click here!
Versions 17.0 18.0 19.0
  • Description
  • Manifest
  • Documentation
  • License
Viindoo Logo
Odoo Community
Odoo Enterprise
Viindoo Cloud

What the API was asked, and what it answered

A log of API requests - method, payload, response status and headers - so an integration can be debugged from the system rather than from a customer's screenshot.

API Request Logger (technical name viin_api_request_logger) is an Odoo 17.0 app for Odoo Community and Odoo Enterprise and Viindoo Cloud, built for integrator, support, developer, administrator.

What the API was asked, and what it answered

At a Glance

The facts of API Request Logger, version 0.1.2, in one place. Published by Viindoo.

Technical name
viin_api_request_logger
Odoo version
17.0 (Odoo Community, Odoo Enterprise, Viindoo Cloud)
Category
Technical
Depends on
base, bus
Adds
3 new models, 1 extended model, 2 menus, 1 access group
Licence
OPL-1
Best for
Integrator; Support; Developer; Administrator
Not for
It logs; it does not replay.
Last updated
2026-09-13
Key features
A central log of API requests and their responses, Method, endpoint, payload, status and response headers, One row for a streamed call too, A mixin so a record can link to the last request that touched it, Readable by administrators, in the back office, Useful for debugging and for settling integration disputes, Nothing changes about how the API behaves
Live demo
v17demo-int.viindoo.com
  • Features
  • Demo
  • Support
  • Releases

How It Works

Two screens.

1

The requests

Endpoint, method and response status - the list a support engineer opens first.

API request logs
2

One request

What was sent and what was answered, in full.

A logged request

What You Get

A central log of API requests and their responses

Method, endpoint, payload, status and response headers

One row for a streamed call too

A mixin so a record can link to the last request that touched it

Readable by administrators, in the back office

Useful for debugging and for settling integration disputes

Nothing changes about how the API behaves

More Screens

Everything below was taken on a database seeded with real business data, on this series - not a mock-up and not a screenshot from an older version.

A request

A request

What This App Does Not Do

Read this before you buy. Everything below is something the app deliberately leaves to another app or to you.

It logs; it does not replay.

Re-sending a failed call is the integration's job.

Logs grow.

Plan a retention policy - a busy API produces a lot of rows.

Payloads may contain personal data.

Restrict access accordingly; the model is administrator-facing on purpose.

It does not monitor uptime.

It records requests that arrived, not the ones that never did.

Works Well With

Apps from the same stack, built to fit this one:

Expiring Tokens

The other half of API hygiene.

Token Expiration

Bank Connector

An integration worth logging.

Bank Connector

Viindoo Base

The foundation layer.

Viindoo Base

Who Should Use API Request Logger?

Integrator

Sees the request as it arrived, not as it was described.

Support

Answers whether a call reached the system.

Developer

Debugs from data instead of from a reproduction attempt.

Administrator

Keeps a trail of what external systems are doing.

Frequently Asked Questions

What does API Request Logger do?

A log of API requests - method, payload, response status and headers - so an integration can be debugged from the system rather than from a customer's screenshot.

What does API Request Logger not do?

It logs; it does not replay. Re-sending a failed call is the integration's job. Logs grow. Plan a retention policy - a busy API produces a lot of rows. Payloads may contain personal data. Restrict access accordingly; the model is administrator-facing on purpose. It does not monitor uptime. It records requests that arrived, not the ones that never did.

Who is API Request Logger for?

Integrator: Sees the request as it arrived, not as it was described. Support: Answers whether a call reached the system. Developer: Debugs from data instead of from a reproduction attempt. Administrator: Keeps a trail of what external systems are doing.

Which Odoo version and editions does it support?

Odoo 17.0 - Odoo Community, Odoo Enterprise, Viindoo Cloud. Upgrades to a newer Odoo series are a separate purchase for that series.

What does it depend on?

It installs on top of: base, bus. Odoo installs them with it.

How do I set it up?

Two screens.

What works well with it?

Expiring Tokens (to_token_expiration): The other half of API hygiene. Bank Connector (viin_bank_connector): An integration worth logging. Viindoo Base (to_base): The foundation layer.

Can I try it before buying?

Yes - the Live Preview button at the top of this page opens the module's own screen on a working database.

How do I get support?

Write to apps.support@viindoo.com with your Odoo version and the technical name viin_api_request_logger; pre-sales questions go to sales@viindoo.com.

See API Request Logger in Action

What the API was asked, and what it answered

User Manual API Request Logger
Live Demo v17demo-int.viindoo.com/web#action=viin_api_request_logger.action_api_request_log or use the Live Preview button at the top of this page

Need help with API Request Logger?

For questions, implementation support, or consulting services, contact Viindoo.

Pre-Sales & Partnership

sales@viindoo.com

When contacting us, please include:

  • Odoo/Viindoo version (Odoo CE / Viindoo Editions).
  • Number of users and business scope.
  • Other modules currently in use.

Technical Support

apps.support@viindoo.com

For faster troubleshooting, please provide:

  • Order number or app reference.
  • Odoo/Viindoo version & edition.
  • Steps to reproduce the issue.
  • Screenshots/logs if available.

Upgrades to a newer Odoo series are a separate purchase for that series.

About Viindoo. Viindoo builds and maintains more than 1,000 apps on the Odoo App Store for the Community and Enterprise editions and runs them on Viindoo Cloud. A purchase of API Request Logger covers the 17.0 series: bug fixes on the module reach you through the store, questions go to apps.support@viindoo.com with the technical name viin_api_request_logger, and moving to a newer Odoo series is a separate purchase for that series. Source code is delivered with the module and stays yours to read and adapt.

Technical Requirement

Editions: Odoo Community, Odoo Enterprise, Viindoo Cloud
License: OPL-1

Changes log

0.1.2 - Latest on the 17.0 line

  • A call whose answer arrives as a stream leaves exactly one log row, written when the stream ends - the body is handed to the caller chunk by chunk as it arrives instead of being swallowed to be logged, and the row records how many chunks and bytes came back, how the stream ended, and how long it took to the last chunk.
  • A viewer mixin lets a record point at the last API request that touched it.
Availability
Odoo Online
Odoo.sh
On Premise
Lines of code 529
Technical Name viin_api_request_logger
LicenseOPL-1
Websitehttps://viindoo.com/apps/modules/17.0/viin_api_request_logger

API Request Logger Documentation

Overview

The viin_api_request_logger module provides a framework for logging and monitoring API requests in Odoo. Designed for developers and administrators, it tracks all details of API interactions, including:

  • User initiating the request
  • Related model and record
  • Request parameters, headers, and payload
  • API response data and errors
  • Request duration

Key Features

  • Detailed Logging: Capture all request/response details, including errors.
  • Secret-Safe Transport Logs: Sensitive header and query-string secrets are masked before being written to api.request.log.
  • Error Monitoring: Automatically logs failed API requests for better debugging.
  • Streaming-Aware Logging: A response consumed as a stream is passed through to the caller chunk by chunk and still leaves exactly one log row, written once the drain ends.
  • Extensible Integration: Easily integrate with models using the provided mixins.
  • User-Friendly API Log Viewer: Quickly access logs related to any model record.
  • Customizable: Fully adaptable for specific business needs.

Installation

  1. Install the module via the Odoo Apps interface or the command line:

    odoo-bin -c <config_file> -i viin_api_request_logger
    
  2. Configure user access rights to ensure secure access to logs.

Usage

Logging API Requests

To enable automatic logging for API requests, inherit the api.request.mixin in your model and use the make_request method. Here's an example:

class ExampleIntegration(models.AbstractModel):
    _name = 'example.integration'
    _inherit = 'api.request.mixin'

    def example_api_call(self):
        response = self.make_request(
            method="GET",
            url="https://api.example.com/data",
            headers={"Authorization": "Bearer <token>"},
            params={"key": "value"},
            res_model="example.model",
            res_id=1,
        )
        return response.json()

Viewing API Logs

To allow users to view related logs, inherit the api.log.viewer.mixin in your model. This mixin provides:

  • `last_api_request_log_id`: A computed field showing the most recent API log.
  • `action_view_api_logs`: An action to display all related logs.

Example:

class ExampleModel(models.Model):
    _name = 'example.model'
    _inherit = 'api.log.viewer.mixin'

Logs can also be accessed via the "API Logs" menu in the Odoo interface.

Logging Guarantees

  • request_headers always masks default sensitive headers such as Authorization and X-API-Key.
  • request_url and name store the effective request URL, including query parameters expanded from params, with sensitive query-string values masked.
  • Each outbound API call creates a single api.request.log record, including HTTP 4xx/5xx responses.
  • Non-JSON responses fall back to raw response.text so HTML/plain-text vendor error pages still appear in the log.
  • A call made with stream_response=True also creates exactly one api.request.log record. The body is never buffered to be logged: iter_lines is wrapped, each line is yielded straight to the caller, and the row is written when the drain finishes - on normal exhaustion, on an exception mid-drain, or on early abandonment.
  • For a streamed call, response_data holds a summary rather than the body - how many chunks and how many bytes arrived, and whether the stream ended done, error or aborted - and duration measures time to the last chunk.
  • Preparing or writing the row for a streamed call can never cost the caller its answer: a failure there is logged as a warning and never re-raised.

Customizing the Logger

Override _prepare_log_values to include custom fields in the log:

def _prepare_log_values(self, method, url, headers, data, response, duration, res_model=None, res_id=None, error_message=None):
    values = super()._prepare_log_values(method, url, headers, data, response, duration, res_model, res_id, error_message)
    values.update({"custom_field": "Custom Value"})
    return values

Configuration

The module works out-of-the-box but can be extended for advanced configurations.

Advanced Scenarios

  • Custom Headers: Use the headers parameter in make_request to add headers such as authentication tokens.
  • Sensitive Query Parameters: Override _get_sensitive_query_param_keys() to mask provider-specific secret query parameters in logged URLs.
  • Streamed Responses: Pass stream_response=True to make_request to receive the response un-drained (the requests library's own stream=True) and read it with iter_lines(). Log timing follows the drain, so read the body to completion where you can.
  • API Monitoring: Leverage the response_headers and response_data fields to debug or analyze responses.
  • Integration with External Tools: Export logs for use with monitoring tools like ELK Stack or Datadog.

Support

For assistance, please contact Viindoo support at https://viindoo.com.

Odoo Proprietary License v1.0

This software and associated files (the "Software") may only be used (executed,
modified, executed after modifications) if you have purchased a valid license
from the authors, typically via Odoo Apps, or if you have received a written
agreement from the authors of the Software (see the COPYRIGHT file).

You may develop Odoo modules that use the Software as a library (typically
by depending on it, importing it and using its resources), but without copying
any source code or material from the Software. You may distribute those
modules under the license of your choice, provided that this license is
compatible with the terms of the Odoo Proprietary License (For example:
LGPL, MIT, or proprietary licenses similar to this one).

It is forbidden to publish, distribute, sublicense, or sell copies of the Software
or modified copies of the Software.

The above copyright notice and this permission notice must be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.

Please log in to comment on this module

  • The author can leave a single reply to each comment.
  • This section is meant to ask simple questions or leave a rating. Every report of a problem experienced while using the module should be addressed to the author directly (refer to the following point).
  • If you want to start a discussion with the author or have a question related to your purchase, please use the support page.
Community
  • Tutorials
  • Documentation
  • Forum
Open Source
  • Download
  • Github
  • Runbot
  • Translations
Services
  • Odoo.sh Hosting
  • Support
  • Upgrade
  • Custom Developments
  • Education
  • Find an Accountant
  • Find a Partner
  • Become a Partner
About us
  • Our company
  • Brand Assets
  • Contact us
  • Jobs
  • Events
  • Podcast
  • Blog
  • Customers
  • Legal • Privacy
  • Security

Odoo is a suite of open source business apps that cover all your company needs: CRM, eCommerce, accounting, inventory, point of sale, project management, etc.

Odoo's unique value proposition is to be at the same time very easy to use and fully integrated.

Website made with