Skip to content

    Pre-launch API. The concepts described here are settled, but the API shape is not: request and response fields, parameters and defaults can still change. Build against it, and talk to your Luigi's Box contact before you put an integration into production.

    Get a feed's processing status

    View source
    GET
    /catalog/v1/{catalog_id}/sources/feeds/{feed_id}/status
    curl --request GET \
    --url https://api.eu1.luigisbox.ai/catalog/v1/example/sources/feeds/1/status \
    --header 'Authorization: Bearer <token>'
    catalog_id
    required
    Catalog Id
    string
    feed_id
    required
    Feed Id
    integer

    Successful Response

    Media type application/json
    FeedStatusResponse
    object
    feed_id
    required
    Feed Id
    integer
    latest_run
    required
    Any of:
    SynchronizationJob
    object
    catalog_id
    required
    Catalog Id
    string
    created_at
    required
    Created At
    string format: date-time
    error_message
    required
    Any of:
    string
    feed_id
    required
    Feed Id
    integer
    fingerprints
    required
    Fingerprints
    boolean
    finished_at
    required
    Any of:
    string format: date-time
    force
    required
    Force
    boolean
    generation
    required
    Any of:
    string format: uuid
    id
    required
    Id
    integer
    items_no_identity
    required
    Any of:
    integer
    items_sent
    required
    Any of:
    integer
    items_skipped
    required
    Any of:
    integer
    started_at
    required
    Any of:
    string format: date-time
    status
    required
    SyncStatus

    Lifecycle status of a synchronization run.

    string
    Allowed values: running succeeded failed skipped
    status_reason
    required
    Any of:
    string
    task_id
    required
    Any of:
    string
    trigger
    required
    SyncTrigger

    What started a synchronization run.

    string
    Allowed values: schedule manual
    triggered_by
    required
    Any of:
    string
    locked
    required
    Locked
    boolean
    state
    required
    Any of:
    FeedState

    What the last processing run recorded about a feed: its HTTP cache validators, the detected format, and how many items it carried.

    object
    concurrency_last_decision
    Any of:
    string
    detected_csv_delimiter
    Any of:
    string
    detected_format
    Any of:
    string
    detected_item_tag
    Any of:
    string
    detected_json_path
    Any of:
    string
    detection_confident
    Any of:
    boolean
    etag
    Any of:
    string
    last_modified
    Any of:
    string
    last_run_at
    Any of:
    string format: date-time
    optimal_parser_concurrency
    Any of:
    integer
    optimal_send_concurrency
    Any of:
    integer
    total_items
    Total Items
    integer
    0
    Example
    {
    "latest_run": {
    "status": "running",
    "trigger": "schedule"
    },
    "state": {
    "total_items": 0
    }
    }

    Missing or invalid credentials

    Media type application/json
    ErrorResponse

    Canonical error body — every non-2xx response uses this shape.

    object
    exception_details
    ExceptionDetails

    Machine-readable error context; empty object when there is nothing to add.

    object
    validation_errors
    Any of:
    Array<object>
    ValidationProblem

    One field-level reason a request was rejected.

    object
    loc
    required
    Loc

    Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

    Array
    msg
    required
    Msg

    What is wrong with the value at loc.

    string
    type
    required
    Type

    Stable machine code for the problem, e.g. missing or string_too_short.

    string
    key
    additional properties
    any
    reason
    required
    Reason

    Human-readable, actionable error message.

    string
    request_id
    Any of:
    string
    Example generated
    {
    "exception_details": {
    "validation_errors": [
    {
    "loc": [
    "example"
    ],
    "msg": "example",
    "type": "example"
    }
    ]
    },
    "reason": "example",
    "request_id": "example"
    }

    Authenticated but not permitted

    Media type application/json
    ErrorResponse

    Canonical error body — every non-2xx response uses this shape.

    object
    exception_details
    ExceptionDetails

    Machine-readable error context; empty object when there is nothing to add.

    object
    validation_errors
    Any of:
    Array<object>
    ValidationProblem

    One field-level reason a request was rejected.

    object
    loc
    required
    Loc

    Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

    Array
    msg
    required
    Msg

    What is wrong with the value at loc.

    string
    type
    required
    Type

    Stable machine code for the problem, e.g. missing or string_too_short.

    string
    key
    additional properties
    any
    reason
    required
    Reason

    Human-readable, actionable error message.

    string
    request_id
    Any of:
    string
    Example generated
    {
    "exception_details": {
    "validation_errors": [
    {
    "loc": [
    "example"
    ],
    "msg": "example",
    "type": "example"
    }
    ]
    },
    "reason": "example",
    "request_id": "example"
    }

    Resource not found

    Media type application/json
    ErrorResponse

    Canonical error body — every non-2xx response uses this shape.

    object
    exception_details
    ExceptionDetails

    Machine-readable error context; empty object when there is nothing to add.

    object
    validation_errors
    Any of:
    Array<object>
    ValidationProblem

    One field-level reason a request was rejected.

    object
    loc
    required
    Loc

    Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

    Array
    msg
    required
    Msg

    What is wrong with the value at loc.

    string
    type
    required
    Type

    Stable machine code for the problem, e.g. missing or string_too_short.

    string
    key
    additional properties
    any
    reason
    required
    Reason

    Human-readable, actionable error message.

    string
    request_id
    Any of:
    string
    Example generated
    {
    "exception_details": {
    "validation_errors": [
    {
    "loc": [
    "example"
    ],
    "msg": "example",
    "type": "example"
    }
    ]
    },
    "reason": "example",
    "request_id": "example"
    }

    Request validation failed

    Media type application/json
    ErrorResponse

    Canonical error body — every non-2xx response uses this shape.

    object
    exception_details
    ExceptionDetails

    Machine-readable error context; empty object when there is nothing to add.

    object
    validation_errors
    Any of:
    Array<object>
    ValidationProblem

    One field-level reason a request was rejected.

    object
    loc
    required
    Loc

    Path to the offending value from the request root, e.g. ["body", "filters", 0, "operator"].

    Array
    msg
    required
    Msg

    What is wrong with the value at loc.

    string
    type
    required
    Type

    Stable machine code for the problem, e.g. missing or string_too_short.

    string
    key
    additional properties
    any
    reason
    required
    Reason

    Human-readable, actionable error message.

    string
    request_id
    Any of:
    string
    Example generated
    {
    "exception_details": {
    "validation_errors": [
    {
    "loc": [
    "example"
    ],
    "msg": "example",
    "type": "example"
    }
    ]
    },
    "reason": "example",
    "request_id": "example"
    }