Tideways Logo Documentation
Go to tideways.com Register Login

Documentation

    • Features
      • Application Monitoring
        • Application Performance Overview
        • Transactions List
        • Transaction Detail View
        • Services
        • Environments
        • HTTP Status Codes
        • Release Tracking
        • Add Marker to Charts
        • Customizable Alerts
        • External HTTP Service Monitoring
        • Page Cache Hit Rates
      • Timeline Profiler
        • Traces Overview
        • Timeline Profiler
        • Timeline Summary
        • Flame Graph View
        • Detect Bottlenecks
        • Find Traces
        • Tracepoints
        • Aggregated Traces
        • Compare Traces
        • Automatic Instrumentation
        • Instrument Functions from UI
        • Distributed Tracing
        • SQL Anonymizing
        • Profiling Spaces
        • Trace Sharing
      • Callgraph Profiler
        • Introduction
        • Namespaces and Packages
        • Argument Capturing
        • Folded Calls
      • Trigger Profiling
        • From the Browser
        • By Appending URL Parameters
        • From a Shell
        • For Ajax Requests
      • Fixing Issues
        • Error Tracking
        • Slow SQL Query Log
        • Deprecations
        • PHP Warnings / Notices
        • Observations
      • History And Weekly Report
        • Email Weekly Report
        • History View
        • Trace History
      • New Features in Recent Plans
    • Compatibility, Requirements
    • Setup
      • Installation
        • Get the API Key
        • Debian/Ubuntu
        • RPM based Systems
        • Linux From a Tarball
        • Docker
        • AWS Elastic Beanstalk
        • bref
        • FrankenPHP
        • Heroku
        • Digitalocean App Platform
        • tideways-daemon Amazon Machine Image (AMI)
        • MacOS and Homebrew
        • DDEV
        • Beta Testing
      • Configuration
        • Configure Via PHP.ini
        • Configure Using Apache Virtual Hosts
        • Configure Using NGINX Virtual Hosts
        • Release Tracking
        • Error Tracking
        • Services
        • Environments
        • Transactions
        • Servers
        • Filter Sensitive Data From Traces and Errors
        • Instrument CLI Scripts
        • Maintenance Events
        • Sampling
        • Advanced Instrumentation
        • Slow SQL Logging
        • Tracepoints
        • Weekly Reports
        • Notifications
        • Response Time Targets
        • Distributed Tracing
        • Warnings / Notices / Deprecations
        • Custom Instrumentation
        • Crawler Detection
        • Profiler
      • Upgrading
        • Upgrading Debian/Ubuntu
        • Upgrading Linux From Tarball
        • Upgrading RedHat/Centos
        • Package Hosting Migration from AWS S3 to Cloudsmith
        • Update From PHP Extension v4 to v5
        • Upgrade To Tideways CLI 0.4
      • Troubleshooting
        • No Data Transmitted? Troubleshooting Checklist
        • Daemon Disabled By Tideways Backend
        • Debugging Segfaults In PHP
        • How To Install Tideways On My Custom PHP Installation
        • SELinux Enabled
        • Uncaught Error Call To Undefined Function tideways_enable()
        • Undefined Symbol php_json_encode Startup Error
        • Using Tideways With Enabled PHP open_basedir
        • tideways/profiler Composer Package is abandoned
    • Reference
      • REST API
        • Authentication Scopes Rate Limiting
        • Performance Metrics API
        • Traces API
        • Issues API
        • History API
        • Users API
        • CLI / Trigger Trace API
        • Hosting Partner API
      • Browser Extension
        • Chrome Extension
      • Concepts
        • What do these metrics and numbers mean?
        • Organizations and Projects
        • Traces per Minute
        • Spans / Trace Limit
        • Percentiles
        • What is "Unaccounted Wait"
        • Profiler
          • Callgraph Profiler
            • Self-time vs Total-time
          • Timeline Profiler
            • Events
            • Timespans
      • Command Line Interface
        • Overview
        • tideways run
        • tideways event create
        • tideways tracepoint create
        • Settings
      • Observations
        • Opcache Enabled
        • Default Socket Timeout
        • display_errors is enabled
        • Default max_execution_time
        • Low Opcache Interned Strings Storage
        • Opcache Cache Keys running low
        • Opcache Memory running low
        • open_basedir is enabled
        • Page Cache Hit Rate is low
        • PHP version is not recent
        • Realpath Cache capacity is running low
        • Xdebug is active
        • Compiler Optimized Functions
        • Time spent Autoloading
        • Time spent Compiling
        • Shopware
          • Admin Worker enabled
          • HTTP Cache inefficient
      • PHP Extension
        • API Overview
        • Callgraph And Timeline
        • Custom Metadata
        • Custom Timespans
        • Detecting Service Name
        • Detecting Transaction Names
        • Ignore Transactions
        • Logging Errors And Detecting Exceptions
        • Profiling Programmatically In PHP Code
        • Layer Metrics API
        • Timeline Event Marker
        • Trigger Callgraph When Function Method Called
        • Recording Page Cache Hits and Misses
        • Custom Tags
        • References Between Traces
        • Supported Frameworks and Databases
        • IDE Stubs
      • Daemon
        • Configuration Reference
        • Multiple Environments On Same Server
        • Running The Daemon On A Dedicated Host
        • Log Anonymizer Parsing Errors
      • Proxy
        • Setting Up Tideways Collection Proxy
        • TLS Troubleshooting
      • FAQ
        • "default" Transaction explained
        • What Data From My Application Exactly Is Tideways Collecting
      • Alerting & Notification Rules
        • Transaction Failure Rates
        • Missing Data Transmission
      • Integrations
        • Triggering Traces
          • Triggering Traces with ChecklyHQ
          • Triggering Traces with Postman
          • Triggering Traces with Locust
        • Sending Notifications
          • Notifications
          • E-Mail
          • Slack
          • Microsoft Teams
          • Checkly
          • Opsgenie
          • PagerDuty
          • Statsd
          • Webhook
          • Splunk OnCall (VictorOps)
        • Source Code Integrations
          • VSCode, PhpStorm
        • Frameworks
          • Drupal 7
          • Laravel Queues
          • Laravel Octane
    • Account and Billing
      • Billing and Invoices
        • Subscribe to Tideways
        • Edit Billing Information
        • Change Billing from Monthly to Yearly
        • View and Download Invoices
        • Change your Invoice Emails
        • Pause Your Subscription
        • Resume Your Subscription
        • Cancel Your Subscription
        • Upgrade Your Subscription
        • Switch To SEPA Payment
        • Update SEPA Mandate
        • Transfer Ownership
        • Project Sizes
        • Switch Floating License
        • Request-based Pricing
        • Legacy Plans
      • GDPR Compliance
      • Users and Access Control
      • Teams
      • Single Sign-On (SSO)
        • Azure Active Directory
        • GitHub
      • Two-Factor Authentication
      • Partner Accounts
Documentation Current
  • Academy
    • Current
  • Documentation
    • Current
  • Documentation
  • REST API

REST API

In this section, you’ll find all that you need regarding accees to different Tideways REST APIs.

The REST API is not related to API Keys to configure Tideways for transmitting data. You will find information about data transmission API Key under Setup.

  • Authentication, Scopes, and Rate Limiting

  • Issues API

  • History API

  • Hosting Partner API

  • Performance Metrics API

  • Traces API

  • CLI / Trigger Trace API

Still need help? Email [email protected]
Do you have questions or have feedback about this documentation page? Please let us know at [email protected].
© Tideways GmbH 2020-2025. Powered by Antora
Imprint | Privacy Policy
×