Skip to main content

List of all report runs or with filters

GET 
/reportruns/

List of all report runs or with filters

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 report runs retrieved successfully

Schema

  • Array [

    • guid uuid

    Unique identifier for the report run.

    _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

    type string

    The type of report run.

    name string

    The name of report run.

    published booleandeprecated

    Flag to check if report is published.

    extractorId uuid

    The extractor that this report is associated with.

    configId uuid

    The configuration of the report associated with this report run.

    reportId uuid

    The report associated with this report run.

    status string

    Current status of the report run.

    inputs

    object

    The inputs for the report run. May include details such as extractor ID and comparison IDs for diff reports.

    property name* object

    The inputs for the report run. May include details such as extractor ID and comparison IDs for diff reports.

    csv uuid

    [internal] CSV containing the results of the report.

    json uuid

    [internal] JSON containing the results of the report.

    log uuid

    [internal] Log file containing error and warnings from reports.

    pdf uuid

    [internal] PDF containing the results of the report, generated to send as email attachments.

    xlsx uuid

    [internal] xlsx containing the results of the report.

    summary

    object

    Summary of the report run.

    property name* object

    Summary of the report run.

    errorMessage string

    Error message for a failed report.

    archived boolean

    Flag to suppress display of report run.

  • ]

Loading...