Need help with your APIs? I offer API discovery, governance & evangelism services. Explore services →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

Import.io Report API

Manage reports built on top of extractors.

Import.io Report API is one of 5 APIs that Import.io publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

Tagged areas include Report. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 5 operations across 4 paths, and defines 4 schemas. It is described by OpenAPI 3.0.3, at version 2.0.

Requests are made against a single base URL, https://api.import.io.

5 operations 4 paths 4 schemas 1 DELETE3 GET1 POST

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
2.0
Base URL
https://api.import.io
Authentication
API Key
Resource Areas
1

Authentication & Security 1

Import.io Report API declares 1 security scheme for authenticating requests. An API key is passed in the query as _apikey (apiKeyAuth). By default, every request must be authenticated.

  • apiKeyAuth — API key obtained from the Import.io dashboard User Settings.

Paths & Operations 5

Across 4 paths, the API surfaces 5 operations — 1 DELETE, 3 GET, 1 POST. Each is listed below with its method, path, parameters, and response codes.

Report 5

Manage reports built on top of extractors.

GET
/reports/
List reports
listReports 5 params → 200401
GET
/reports/{reportId}
Get report
getReport 2 params → 200401404
DELETE
/reports/{reportId}
Delete report
deleteReport 2 params → 200401404500
POST
/reports/{reportId}/start
Start report
startReport 2 params → 200401404500
GET
/reports/{reportId}/reportruns
List report runs for a report
listReportRunsForReport 6 params → 200401404

Schemas 4

The contract defines 4 schemas that model the data the API accepts and returns. The most detailed are ReportRun (17 properties), Report (7 properties), Meta (5 properties), Error (3 properties). Each schema is shown below with its type and property counts.

Error
object
3 properties
Meta
object
Common metadata included on most resources.
5 properties
ReportRun
object
17 properties
Report
object
7 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

import-io-report-api-openapi.yml Raw ↑

Other APIs Import.io publishes across the network.

Import.io Crawlrun API
Import.io Extractor API
Import.io ReportRun API
Import.io User API