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 ReportRun API

Retrieve report run executions and their result files.

Import.io ReportRun 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 ReportRun. The published artifact set on APIs.io includes an OpenAPI specification and API documentation.

This API exposes 3 operations across 3 paths, and defines 3 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.

3 operations 3 paths 3 schemas 3 GET

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 ReportRun 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 3

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

ReportRun 3

Retrieve report run executions and their result files.

GET
/reportruns/
List report runs
listReportRuns 5 params → 200401
GET
/reportruns/{reportRunId}
Get report run
getReportRun 2 params → 200401404
GET
/reportruns/{reportRunId}/{fileType}
Get report run results file
getReportRunFile 3 params → 200401404

Schemas 3

The contract defines 3 schemas that model the data the API accepts and returns. The most detailed are ReportRun (17 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

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

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

Other APIs Import.io publishes across the network.

Import.io Crawlrun API
Import.io Extractor API
Import.io Report API
Import.io User API