Skip to main content

List of reports

GET 
/reports/

List of reports

Request​

Query Parameters

    _apikey stringrequired

    You can find your API key in the Import.io dashboard under User Settings

    _perpage integer

    Number of items to return per page

    _page integer

    Page number to return (default is 1)

    _sort string

    Field name to sort by.

    To sort by created time, use _sort=meta_created_at.

    _sortDirection string

    Possible values: [ASC, DESC]

    Sort order.

    Default is DESC.

Responses​

List of reports retrieved successfully

Schema

  • Array [

    • guid uuid

    Unique identifier for the report.

    _meta

    object

    [internal] The metadata of the object

    timestamp int64required

    The timestamp of the last change to the object

    creationTimestamp int64

    The timestamp of the object's creation

    patchTimestamp int64

    The timestamp of the last patch to the object

    objectGuid uuid

    The identifier of the object

    lastEditorGuid uuid

    The identifier of the last editor of the object

    ownerGuid uuid

    The identifier of the owner of the object

    creatorGuid uuid

    The identifier of the creator of the object

    orgGuid uuid

    The identifier of the organization the object belongs to

    deleted boolean

    The flag indicating if the object is deleted

    name string

    The report's name.

    type string

    The type of report.

    extractorId uuid

    Identifier of the extractor associated with this report.

    latestConfigId uuid

    Identifier of the latest report run configuration.

    archived boolean

    Flag to suppress display of report.

    autoPublish booleandeprecated

    Flag to auto-publish report.

  • ]

Loading...