🤖API - Early Access

Early Preview Access to Our API

We're thrilled to announce that our API is currently in early preview! This is a unique opportunity to be among the first to explore our new features, and it's completely free. We understand the importance of building a tool that meets your needs, and we're dedicated to making our API the best it can be.

As we are in the alpha stage, please be aware that you might encounter some rough edges, and we're actively working on improvements. Your feedback is invaluable to us during this phase. Whether you have questions, suggestions, or just want to share your thoughts, we're all ears.

Getting started with Monitoro API

Monitoro API is designed to extend your projects and automations with the ability to retrieve data from any website in your personal browser, with minimal scraping or even coding experience.

To get started with an API token or to share your feedback, please don't hesitate to reach out to us at [email protected]. Your input will be instrumental in shaping the future of our API, and we're excited to embark on this journey together. Let's create something amazing!

---

Authentication

All Monitoro API endpoints use a Bearer token authentication. During the alpha phase you can request a token by contacting us at [email protected].

Once you get your API token from us, send an Authorization header with Bearer mtat-abc123 with every request you make.

---

Extract data from URL

https://api.monitoro.app/v1/monitors/{monitorId}/extract

How does it work? This method lets you extract or scrape data directly using your own browser. Using the data selection and automation from any of your monitors, this method will extract data and optionally run your monitor's automations with it.

First, open your monitor in Monitoro and retrieve the monitorId from the address at the top. It is the long text after https://monitoro.app/monitors/....

Make sure your browser is running and the extension is installed & logged in before calling this API method, since it is made to let you automate your browser. Extraction will fail immediately if you don't have the extension running and you will receive an error response.

You then have two options to call this method's endpoint:

Extract & Run automations

The Extract data from URL method extracts data and sends it to your automations if noIngest is false or not defined.

• This endpoint does not wait for the automations to run and returns data as soon as it is extracted.

• You have access to the full array of apps supported by Monitoro.

Example payload:

{
    "url": "https://example.com"
}

Extract only

The Extract data from URL can also simply return data without running automations. Specify noIngest as true to achieve this.

• Make sure to respect your local laws and the terms of the website. Example payload:

{
    "url": "https://example.com",
    "noIngest": true
}

In both cases the endpoint will return data it extracted, and any error encountered during the process.

Error status codes

This API can return responses with the status 200, 400, 404 and 500. Please look at the response block below, and click on the dropdown with "200" in it to see Error codes.

Extract data from URL

post

This endpoint allows for the manual extraction of data from a specified URL, using the settings configured for a given monitor. It can also optionally run the automations associated with the monitor.

Authorizations

BearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

monitorIdstringRequired

The ID of the monitor whose settings are to be used for extraction

Body

application/json

urlstringRequired

The URL from which data is to be extracted

Example: https://example.com/page

noIngestbooleanOptional

Determines if the monitor's automations are executed. Set to false to skip automations. Note: Ensure automations do not depend on past data comparisons.

Example: false

Responses

200

Data extracted successfully

application/json

400

Bad request, such as missing URL or malformed request

application/json

404

Monitor not found

application/json

500

Server error during data extraction

application/json

post

https://api.monitoro.app/v1/monitors/{monitorId}/extract

HTTPcURLJavaScriptPython

POST https://api.monitoro.app/v1/monitors/{monitorId}/extract HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 51

{
  "url": "https://example.com/page",
  "noIngest": false
}

{
  "success": true,
  "data": {
    "data": {},
    "error": null
  }
}

---

Need help?

❓Common questions (FAQ)⛑️Troubleshooting🚁Support