MerchantHQ API
GET /2024-09/suppliers/{supplier}/scraping-attempts
Default

Get a paginated list of supplier scraping attempts for a specific supplier

Path parameters

  • supplier string(uuid) Required

    The supplier ID

Query parameters

  • page integer

    Page number

    Minimum value is 1. Default value is 1.

  • per_page integer

    Number of items per page

    Minimum value is 1, maximum value is 100. Default value is 15.

  • from_date string(date)

    Filter attempts scheduled from this date (inclusive)

  • to_date string(date)

    Filter attempts scheduled up to this date (inclusive)

  • not_started boolean

    Filter to only show attempts that have not started yet

Responses

  • 200 application/json

    Supplier scraping attempts retrieved successfully

    Hide response attributes Show response attributes object
    • links object
      Hide links attributes Show links attributes object
      • first string
      • last string
      • prev string | null
      • next string | null
    • meta object
      Hide meta attributes Show meta attributes object
      • current_page integer
      • from integer | null
      • last_page integer
      • path string
      • per_page integer
      • to integer | null
      • total integer
    • data array[object]
      Hide data attributes Show data attributes object
      • id string(uuid) Required

        The UUID of the resource.

      • supplier_id string(uuid) Required

        The UUID of the resource.

      • scheduled_to_run_at string(date-time) Required

        The date and time the resource was created or updated.

      • attempt_started_at string | null

        When the attempt failed

      • attempt_failed_at string | null

        When the attempt failed

      • failure_data object | null

        JSON data about the failure

      • attempt_completed_at string | null

        When the attempt was completed successfully

      • found_items_count integer | null

        Number of items found in this attempt

        Minimum value is 0.

      • created_at string(date-time) Required

        The date and time the resource was created or updated.

      • updated_at string(date-time) Required

        The date and time the resource was created or updated.
  • 401
  • 403
GET /2024-09/suppliers/{supplier}/scraping-attempts 
curl \
 --request GET 'https://app.merchanthq.com/api/2024-09/suppliers/{supplier}/scraping-attempts' \
 --header "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
{
  "links": {
    "first": "https://app.merchanthq.com/api/2024-09/merchants?page=1",
    "last": "https://app.merchanthq.com/api/2024-09/merchants?page=10",
    "prev": "https://app.merchanthq.com/api/2024-09/merchants?page=1",
    "next": "https://app.merchanthq.com/api/2024-09/merchants?page=3"
  },
  "meta": {
    "current_page": 1,
    "from": 1,
    "last_page": 10,
    "path": "https://app.merchanthq.com/api/2024-09/merchants",
    "per_page": 10,
    "to": 10,
    "total": 20
  },
  "data": [
    {
      "id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
      "supplier_id": "1e7f0a0f-b5a9-4d1a-a2d5-d0e0c2b1c3d4",
      "scheduled_to_run_at": "2025-01-10T10:37:11Z",
      "attempt_started_at": "string",
      "attempt_failed_at": "string",
      "failure_data": {},
      "attempt_completed_at": "string",
      "found_items_count": 42,
      "created_at": "2025-01-10T10:37:11Z",
      "updated_at": "2025-01-10T10:37:11Z"
    }
  ]
}