/cpsc/reports/search

POST /api/cpsc/reports/search

Price: 20 credits

Search consumer incident reports on SaferProducts.gov by keyword, or by product, brand, model and incident state: product details, incident narrative, victims and injuries, manufacturer comment.

How to use it

Use it to find what consumers reported about a product or brand, or incidents in one US state. `keyword` runs on its own; `product`, `brand`, `model` and `location` narrow together. Feed `id` into cpsc/reports for the same record.

Parameters

• access-token string required

Request body

• timeout integer — Max scrapping execution timeout (in seconds) (default: 300; min: 20; max: 1500)
• keyword string nullable — Full-text keyword; cannot be combined with the other filters (examples: "crib")
• product string nullable — Product name text (examples: "crib")
• brand string nullable — Brand name text (examples: "Graco")
• model string nullable — Model name or number text (examples: "4 in 1")
• location string nullable — US state of the incident, full name; abbreviations match nothing (examples: "Texas")
• count integer required — Max number of results (min: 1; max: 500)

Response

• @type string (default: "CpscReport")
• id string required
• report_number string required
• url string required
• summary string nullable
• product_description string nullable
• manufacturer string nullable
• brand string nullable
• model string nullable
• serial_number string nullable
• upc string nullable
• sku string nullable
• manufactured_date string nullable
• retailer string nullable
• retailer_state string nullable
• purchase_date string nullable
• product_category string nullable
• product_type string nullable
• product_code string nullable
• product_code_name string nullable
• incident_description string nullable
• incident_date string nullable
• incident_location string nullable
• victims array (default: [])
  • @type string (default: "CpscReportVictim")
  • injury string nullable
  • relationship string nullable
  • sex string nullable
  • age string nullable
• has_product boolean nullable
• is_damaged_before_incident boolean nullable
• is_modified_before_incident boolean nullable
• explanation string nullable
• has_contacted_manufacturer boolean nullable
• plans_to_contact_manufacturer boolean nullable
• manufacturer_comment string nullable
• report_date string nullable
• sent_to_manufacturer_date string nullable
• published_date string nullable
• submitter_category string nullable
• image_urls array (default: [])

Errors

• 422 — The request body did not validate Check the fields against this schema. A URN with the wrong prefix is the most common cause.
• 408 — The request ran past its time limit Raise `timeout` in the request body, up to the maximum this endpoint documents. Lowering `count` or turning off the `with_*` flags also helps, because less work finishes sooner.
• 412 — The entity was not found, or a precondition failed Retrying will not help: either the entity does not exist, or the input points at a different one.
• 429 — Too many requests: a rate limit or a usage window is exhausted When the response carries an X-Retry-After header, wait that many seconds and retry: the same number is in the body as `detail.retry_after`, and the limit clears once that window passes. The message in the body names the limit that was hit.
• 500 — Something broke on our side Retrying will not help. If it keeps happening, send us the X-Request-ID from the response headers.
• 529 — Rate limit reached, or the endpoint is overloaded Wait at least 30 seconds, then retry.

Response headers

• X-Error — Error message text (present only on error)
• X-Request-ID — Unique request identifier
• X-Execution-Time — Execution time in seconds
• X-Result-Count — How many records the body carries. 0 means an empty result, which is a normal answer and not by itself an error. A non-zero count can come back together with X-Error when the failure happened partway through — read this header and X-Error independently.
• X-Total-Available-Results — How many records exist for this query, when the endpoint can say. On a `dry_run` request this is the answer and the body is empty. It saturates: the endpoint's documented maximum means 'at least that many', any smaller number is exact.
• X-Warning — Present when the request body carried keys this endpoint does not document. They were ignored, so any filter you meant to apply through them did not apply. Check the spelling against this schema and retry.
• X-Retry-After — Seconds to wait before retrying. Present only on 429.