{"openapi":"3.1.0","info":{"title":"PressProve API","version":"v1","summary":"Check a public page: is it live, is your text there, is your link there and with which rel, is it labeled as paid.","description":"Every answer says what we saw and when. A value we could not observe is returned as an unknown with its reason, never as a guess. Test keys (pp_test_) return deterministic sample answers and cost nothing; live keys (pp_live_) check the real page."},"servers":[{"url":"https://pressprove.com/api/v1"}],"tags":[{"name":"meta"},{"name":"checks"},{"name":"monitors"},{"name":"reports"},{"name":"balance"},{"name":"events"}],"security":[{"bearerAuth":[]}],"paths":{"/":{"get":{"operationId":"api-info","tags":["meta"],"summary":"Describe the API","description":"Returns the API version and where the docs and the OpenAPI document are. Needs no key.\n\nTest mode: Same answer in both modes.","parameters":[],"responses":{"200":{"description":"The API description.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiInfo"},"examples":{"example1":{"summary":"Describe the API","value":{"object":"api","version":"v1","docs_url":"https://pressprove.com/docs","openapi_url":"https://pressprove.com/api/v1/openapi.json"}}}}}}},"security":[],"x-pressprove-scope":null,"x-pressprove-idempotency":"none"}},"/openapi.json":{"get":{"operationId":"openapi","tags":["meta"],"summary":"Get the OpenAPI document","description":"The whole API as an OpenAPI 3.1 document, generated from the same source as this reference. Also served at /openapi.json. Needs no key.\n\nTest mode: Same document in both modes. The example shows only its first keys.","parameters":[],"responses":{"200":{"description":"The OpenAPI document.","content":{"application/json":{"schema":{"type":"object"},"examples":{"example1":{"summary":"The start of the document","value":{"openapi":"3.1.0","info":{"title":"PressProve API","version":"v1"}}}}}}}},"security":[],"x-pressprove-scope":null,"x-pressprove-idempotency":"none"}},"/prices":{"get":{"operationId":"retrieve-prices","tags":["meta"],"summary":"Get the price card","description":"Credits per page check, re-check and proof report, the press release packages, and the top-up packs. A price that is not set yet is null. The unit is fixed: 1 credit is US$0.001. Needs no key.\n\nTest mode: Test mode costs nothing whatever the card says.","parameters":[],"responses":{"200":{"description":"The price card.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/PriceCard"},"examples":{"example1":{"summary":"The price card as it stands today","value":{"currency":"USD","credits_per_usd":1000,"check":{"link_check":2,"text":30},"monitor_run":{"link_check":1,"text":2},"report":2500,"unverifiable_page":1,"unverifiable_free_share":0.2,"unverifiable_free_minimum":100,"release":{"basic":49000,"standard":79000,"premium":129000},"top_up_packs":[{"id":"usd_20","usd":20,"bonus_percent":0,"credits":20000,"price_cents":2000},{"id":"usd_100","usd":100,"bonus_percent":10,"credits":110000,"price_cents":10000},{"id":"usd_500","usd":500,"bonus_percent":20,"credits":600000,"price_cents":50000},{"id":"usd_2000","usd":2000,"bonus_percent":30,"credits":2600000,"price_cents":200000}],"minimum_top_up_usd":20,"free_live_link_checks_per_month":20,"placeholder":false}}}}}}},"security":[],"x-pressprove-scope":null,"x-pressprove-idempotency":"none"}},"/checks":{"post":{"operationId":"create-check","tags":["checks"],"summary":"Create a check","description":"Checks one or more public pages and answers 202 at once with the check queued. Read the result with GET /checks/{id}. With text, each page is searched for your text and your link; without text, each page is searched for a link to your domain. We fetch each page once, and read its robots.txt. We send no cookies or credentials.\n\nTest mode: Nothing is fetched and nothing is charged. The check completes about two seconds later. The answer depends on the words in the page path: see Test mode.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Makes a retry safe: the same key with the same request returns the first answer. See Idempotency.","schema":{"type":"string","description":"1 to 255 printable ASCII characters.","minLength":1,"maxLength":255}}],"responses":{"202":{"description":"The check, queued.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"},"examples":{"example1":{"summary":"Check a page for a link to your site","value":{"id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","object":"check","livemode":false,"status":"queued","mode":"link_check","kind":"check","source":"api","monitor_id":null,"project_id":null,"client_domain":"example.com","page_count":1,"pages":[],"rejected":[],"summary":null,"credits":{"held":0,"charged":null,"free_pages":0},"failure_code":null,"metadata":{},"created_at":"2026-11-02T09:30:00Z","started_at":null,"completed_at":null}},"example2":{"summary":"Check a page for your text","value":{"id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","object":"check","livemode":false,"status":"queued","mode":"text","kind":"check","source":"api","monitor_id":null,"project_id":null,"client_domain":"example.com","page_count":1,"pages":[],"rejected":[],"summary":null,"credits":{"held":0,"charged":null,"free_pages":0},"failure_code":null,"metadata":{},"created_at":"2026-11-02T09:30:00Z","started_at":null,"completed_at":null}}}}}},"400":{"description":"Error. The code is one of: body_not_json, unknown_parameter, parameter_missing, parameter_invalid, pages_empty, too_many_pages, no_usable_page, client_domain_invalid, text_too_short, text_too_long, text_given_for_link_check, mode_unknown, idempotency_key_invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Error. The code is one of: insufficient_balance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope, country_blocked, account_frozen, account_not_onboarded, live_mode_closed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"413":{"description":"Error. The code is one of: body_too_large.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"422":{"description":"Error. The code is one of: idempotency_key_reused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited, account_daily_limit, pending_pages_limit, target_host_limit, free_allowance_paused, daily_work_budget_reached, new_account_spend_limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"503":{"description":"Error. The code is one of: engine_unavailable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"checks:write","x-pressprove-idempotency":"recommended","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateCheckInput"},"examples":{"example1":{"summary":"Check a page for a link to your site","value":{"pages":["https://news.example.org/2026/11/live-link-roastery"],"client_domain":"example.com"}},"example2":{"summary":"Check a page for your text","value":{"pages":["https://news.example.org/2026/11/live-link-roastery"],"client_domain":"example.com","text":"Harbor Lane Coffee has opened its second roastery in Tacoma, Washington. The new site roasts eleven single-origin beans each week and offers public tasting sessions on Saturdays. Owner Dana Whitfield said the expansion follows steady demand from local cafes and restaurants. Tours of the roastery can be booked on the company website, example.com."}}}}}}},"get":{"operationId":"list-checks","tags":["checks"],"summary":"List checks","description":"Your checks, newest first, without their pages. Filter by status or by the monitor that made them.\n\nTest mode: A test key lists test checks only.","parameters":[{"name":"status","in":"query","required":false,"description":"Only checks in this state.","schema":{"type":"string","enum":["queued","running","completed","failed","canceled"]}},{"name":"monitor_id","in":"query","required":false,"description":"Only checks made by this monitor.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"How many objects to return, 1 to 100. Default 20.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","required":false,"description":"The id of the last object you have. Returns the objects after it. Newest first.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of checks.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListCheckSummary"},"examples":{"example1":{"summary":"The latest completed check","value":{"object":"list","data":[{"id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","object":"check","livemode":false,"status":"completed","mode":"link_check","kind":"check","source":"api","monitor_id":null,"project_id":null,"client_domain":"example.com","page_count":1,"rejected":[],"summary":{"verdicts":{"LINK_LIVE":1},"headline":{"verdict":"LINK_LIVE","pages":1,"distinct_domains":1}},"credits":{"held":0,"charged":0,"free_pages":0},"failure_code":null,"metadata":{},"created_at":"2026-11-02T09:30:00Z","started_at":"2026-11-02T09:30:02Z","completed_at":"2026-11-02T09:30:03Z"}],"has_more":false,"next_starting_after":null}}}}}},"400":{"description":"Error. The code is one of: parameter_invalid, limit_invalid, cursor_invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/checks/{id}":{"get":{"operationId":"retrieve-check","tags":["checks"],"summary":"Retrieve a check","description":"One check with its page results. While the check is queued or running, pages is empty: poll every few seconds until status is completed, failed or canceled. Every observation is either a value we saw or an unknown with its reason.\n\nTest mode: A test key reads test checks only; a live id is a 404.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the check.","schema":{"type":"string","description":"chk_..."}}],"responses":{"200":{"description":"The check.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"},"examples":{"example1":{"summary":"A link check that found the link","value":{"id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","object":"check","livemode":false,"status":"completed","mode":"link_check","kind":"check","source":"api","monitor_id":null,"project_id":null,"client_domain":"example.com","page_count":1,"pages":[{"object":"page_result","position":0,"url":"https://news.example.org/2026/11/live-link-roastery","verdict":"LINK_LIVE","fetched_at":"2026-11-02T09:30:00Z","reused":false,"final_url":{"known":true,"value":"https://news.example.org/2026/11/live-link-roastery"},"http_status":{"known":true,"value":200},"registrable_domain":{"known":true,"value":"news.example.org"},"text":{"found":{"known":false,"reason":"text_not_supplied_link_check_mode"},"matched_phrase":{"known":false,"reason":"text_not_supplied_link_check_mode"},"match_zone":{"known":false,"reason":"text_not_supplied_link_check_mode"}},"links":{"present":{"known":true,"value":true},"count":{"known":true,"value":1},"rel_summary":{"known":true,"value":"sponsored nofollow"},"items":[{"href":"https://example.com/","rel_raw":"sponsored nofollow","rel_tokens":["sponsored","nofollow"],"anchor_text":"Sample anchor","zone":"body"}],"items_truncated":false},"disclosure":{"present":{"known":true,"value":true},"explicit":{"known":true,"value":true},"prominence":{"known":true,"value":"headline_area"},"matches":[{"term":"sponsored","matched_text":"Sponsored","zone":"headline_area","strength":"explicit"}]},"noindex":{"known":true,"value":false},"canonical_url":{"known":true,"value":"https://news.example.org/2026/11/live-link-roastery"},"published_at":{"known":false,"reason":"no_publication_date_found"},"charged":false,"unknowns":[{"field":"text.found","reason":"text_not_supplied_link_check_mode"},{"field":"text.matched_phrase","reason":"text_not_supplied_link_check_mode"},{"field":"text.match_zone","reason":"text_not_supplied_link_check_mode"},{"field":"published_at","reason":"no_publication_date_found"}]}],"rejected":[],"summary":{"verdicts":{"LINK_LIVE":1},"headline":{"verdict":"LINK_LIVE","pages":1,"distinct_domains":1}},"credits":{"held":0,"charged":0,"free_pages":0},"failure_code":null,"metadata":{},"created_at":"2026-11-02T09:30:00Z","started_at":"2026-11-02T09:30:02Z","completed_at":"2026-11-02T09:30:03Z"}},"example2":{"summary":"A text check on a page that blocks robots","value":{"id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","object":"check","livemode":false,"status":"completed","mode":"text","kind":"check","source":"api","monitor_id":null,"project_id":null,"client_domain":"example.com","page_count":1,"pages":[{"object":"page_result","position":0,"url":"https://news.example.org/2026/11/unverifiable-roastery","verdict":"UNVERIFIABLE","fetched_at":"2026-11-02T09:30:00Z","reused":false,"final_url":{"known":false,"reason":"robots_disallowed"},"http_status":{"known":false,"reason":"robots_disallowed"},"registrable_domain":{"known":true,"value":"news.example.org"},"text":{"found":{"known":false,"reason":"robots_disallowed"},"matched_phrase":{"known":false,"reason":"robots_disallowed"},"match_zone":{"known":false,"reason":"robots_disallowed"}},"links":{"present":{"known":false,"reason":"robots_disallowed"},"count":{"known":false,"reason":"robots_disallowed"},"rel_summary":{"known":false,"reason":"robots_disallowed"},"items":[],"items_truncated":false},"disclosure":{"present":{"known":false,"reason":"robots_disallowed"},"explicit":{"known":false,"reason":"robots_disallowed"},"prominence":{"known":false,"reason":"robots_disallowed"},"matches":[]},"noindex":{"known":false,"reason":"robots_disallowed"},"canonical_url":{"known":false,"reason":"robots_disallowed"},"published_at":{"known":false,"reason":"robots_disallowed"},"charged":false,"unknowns":[{"field":"final_url","reason":"robots_disallowed"},{"field":"http_status","reason":"robots_disallowed"},{"field":"text.found","reason":"robots_disallowed"},{"field":"text.matched_phrase","reason":"robots_disallowed"},{"field":"text.match_zone","reason":"robots_disallowed"},{"field":"links.present","reason":"robots_disallowed"},{"field":"links.count","reason":"robots_disallowed"},{"field":"links.rel_summary","reason":"robots_disallowed"},{"field":"disclosure.present","reason":"robots_disallowed"},{"field":"disclosure.explicit","reason":"robots_disallowed"},{"field":"disclosure.prominence","reason":"robots_disallowed"},{"field":"noindex","reason":"robots_disallowed"},{"field":"canonical_url","reason":"robots_disallowed"},{"field":"published_at","reason":"robots_disallowed"}]}],"rejected":[],"summary":{"verdicts":{"UNVERIFIABLE":1},"headline":{"verdict":"VERIFIED_LIVE","pages":0,"distinct_domains":0}},"credits":{"held":0,"charged":0,"free_pages":0},"failure_code":null,"metadata":{},"created_at":"2026-11-02T09:30:00Z","started_at":"2026-11-02T09:30:02Z","completed_at":"2026-11-02T09:30:03Z"}}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/checks/{id}/csv":{"get":{"operationId":"download-check-csv","tags":["checks"],"summary":"Download a check as CSV","description":"One row per page, as text/csv (UTF-8 with a byte-order mark, CRLF line ends). An unknown cell reads UNKNOWN (reason); it is never empty and never 0. A cell that starts with = + - @ is prefixed with an apostrophe.\n\nTest mode: Same columns; test rows say so in the check, not in the file.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the check.","schema":{"type":"string","description":"chk_..."}}],"responses":{"200":{"description":"The CSV file.","content":{"text/csv":{"schema":{"type":"string","description":"text/csv, UTF-8 with a byte-order mark."},"examples":{"example1":{"summary":"The CSV of the first check","value":"position,url,verdict,http_status,final_url,text_found,link_present,link_count,rel_summary,disclosure_present,disclosure_explicit,noindex,canonical_url,published_at,fetched_at,reused,unknown_fields,charged\r\n0,https://news.example.org/2026/11/live-link-roastery,LINK_LIVE,200,https://news.example.org/2026/11/live-link-roastery,UNKNOWN (text_not_supplied_link_check_mode),true,1,sponsored nofollow,true,true,false,https://news.example.org/2026/11/live-link-roastery,UNKNOWN (no_publication_date_found),2026-11-02T09:30:00Z,false,text.found text.matched_phrase text.match_zone published_at,false\r\n"}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error. The code is one of: check_not_completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/checks/{id}/cancel":{"post":{"operationId":"cancel-check","tags":["checks"],"summary":"Cancel a check","description":"Cancels a check that is still queued and returns every credit held for it. A check that has started cannot be canceled.\n\nTest mode: A test check completes about two seconds after it is queued, so cancel it straight away.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the check.","schema":{"type":"string","description":"chk_..."}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Makes a retry safe: the same key with the same request returns the first answer. See Idempotency.","schema":{"type":"string","description":"1 to 255 printable ASCII characters.","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"The check, canceled.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"},"examples":{"example1":{"summary":"Cancel right after creating","value":{"id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","object":"check","livemode":false,"status":"canceled","mode":"link_check","kind":"check","source":"api","monitor_id":null,"project_id":null,"client_domain":"example.com","page_count":1,"pages":[],"rejected":[],"summary":null,"credits":{"held":0,"charged":0,"free_pages":0},"failure_code":null,"metadata":{},"created_at":"2026-11-02T09:30:00Z","started_at":null,"completed_at":"2026-11-02T09:30:03Z"}}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error. The code is one of: check_not_cancelable.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"checks:write","x-pressprove-idempotency":"recommended"}},"/monitors":{"post":{"operationId":"create-monitor","tags":["monitors"],"summary":"Create a monitor","description":"Re-checks the same pages on a schedule. Give check_id to copy the pages, domain and mode from a completed check, or give pages and client_domain. Every schedule ends: daily after 90 days, weekly after 365, day7_day30 at day 30. Set notify_email to get one summary email when pages change; it is off by default for monitors made by API.\n\nTest mode: A test monitor runs once when you create it and again on POST /monitors/{id}/run. It never runs on its schedule.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Makes a retry safe: the same key with the same request returns the first answer. See Idempotency.","schema":{"type":"string","description":"1 to 255 printable ASCII characters.","minLength":1,"maxLength":255}}],"responses":{"201":{"description":"The monitor.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Monitor"},"examples":{"example1":{"summary":"Watch the pages of a check every day","value":{"id":"mon_0Lr8KtV3gH5bZy7pW2rXgE","object":"monitor","livemode":false,"status":"active","pause_code":null,"schedule":"daily","mode":"link_check","client_domain":"example.com","pages":["https://news.example.org/2026/11/live-link-roastery"],"source_check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","notify_email":false,"next_run_at":null,"last_run_at":null,"last_check_id":null,"runs_completed":0,"ends_at":"2027-01-31T09:30:00Z","metadata":{},"created_at":"2026-11-02T09:30:00Z","ended_at":null,"project_id":null}}}}}},"400":{"description":"Error. The code is one of: body_not_json, unknown_parameter, parameter_missing, schedule_unknown, pages_empty, too_many_pages, no_usable_page, client_domain_invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Error. The code is one of: insufficient_balance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope, country_blocked, account_not_onboarded, live_mode_closed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error. The code is one of: check_not_completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited, monitor_limit, new_account_spend_limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"monitors:write","x-pressprove-idempotency":"recommended","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateMonitorInput"},"examples":{"example1":{"summary":"Watch the pages of a check every day","value":{"schedule":"daily","check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC"}}}}}}},"get":{"operationId":"list-monitors","tags":["monitors"],"summary":"List monitors","description":"Your monitors, newest first.\n\nTest mode: A test key lists test monitors only.","parameters":[{"name":"status","in":"query","required":false,"description":"Only monitors in this state.","schema":{"type":"string","enum":["active","paused","ended"]}},{"name":"limit","in":"query","required":false,"description":"How many objects to return, 1 to 100. Default 20.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","required":false,"description":"The id of the last object you have. Returns the objects after it. Newest first.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of monitors.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMonitor"},"examples":{"example1":{"summary":"Active monitors","value":{"object":"list","data":[{"id":"mon_0Lr8KtV3gH5bZy7pW2rXgE","object":"monitor","livemode":false,"status":"active","pause_code":null,"schedule":"daily","mode":"link_check","client_domain":"example.com","pages":["https://news.example.org/2026/11/live-link-roastery"],"source_check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","notify_email":false,"next_run_at":null,"last_run_at":null,"last_check_id":null,"runs_completed":0,"ends_at":"2027-01-31T09:30:00Z","metadata":{},"created_at":"2026-11-02T09:30:00Z","ended_at":null,"project_id":null}],"has_more":false,"next_starting_after":null}}}}}},"400":{"description":"Error. The code is one of: parameter_invalid, limit_invalid, cursor_invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/monitors/{id}":{"get":{"operationId":"retrieve-monitor","tags":["monitors"],"summary":"Retrieve a monitor","description":"One monitor, with when it runs next and which check it made last.\n\nTest mode: A test monitor runs once when you create it and again on POST /monitors/{id}/run. It never runs on its schedule.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the monitor.","schema":{"type":"string","description":"mon_..."}}],"responses":{"200":{"description":"The monitor.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Monitor"},"examples":{"example1":{"summary":"Read a monitor","value":{"id":"mon_0Lr8KtV3gH5bZy7pW2rXgE","object":"monitor","livemode":false,"status":"active","pause_code":null,"schedule":"daily","mode":"link_check","client_domain":"example.com","pages":["https://news.example.org/2026/11/live-link-roastery"],"source_check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","notify_email":false,"next_run_at":null,"last_run_at":null,"last_check_id":null,"runs_completed":0,"ends_at":"2027-01-31T09:30:00Z","metadata":{},"created_at":"2026-11-02T09:30:00Z","ended_at":null,"project_id":null}}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"},"delete":{"operationId":"end-monitor","tags":["monitors"],"summary":"End a monitor","description":"Ends the monitor for good. Its past checks and changes stay readable. To stop it for a while, pause it instead.\n\nTest mode: A test monitor runs once when you create it and again on POST /monitors/{id}/run. It never runs on its schedule.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the monitor.","schema":{"type":"string","description":"mon_..."}}],"responses":{"200":{"description":"The monitor, ended.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Monitor"},"examples":{"example1":{"summary":"End a monitor","value":{"id":"mon_0Lr8KtV3gH5bZy7pW2rXgE","object":"monitor","livemode":false,"status":"ended","pause_code":null,"schedule":"daily","mode":"link_check","client_domain":"example.com","pages":["https://news.example.org/2026/11/live-link-roastery"],"source_check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","notify_email":false,"next_run_at":null,"last_run_at":null,"last_check_id":null,"runs_completed":0,"ends_at":"2027-01-31T09:30:00Z","metadata":{},"created_at":"2026-11-02T09:30:00Z","ended_at":"2026-11-02T09:30:03Z","project_id":null}}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error. The code is one of: monitor_ended.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"monitors:write","x-pressprove-idempotency":"none"}},"/monitors/{id}/pause":{"post":{"operationId":"pause-monitor","tags":["monitors"],"summary":"Pause a monitor","description":"Stops the runs until you resume. pause_code reads by_request. The monitor's end date does not move.\n\nTest mode: A test monitor runs once when you create it and again on POST /monitors/{id}/run. It never runs on its schedule.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the monitor.","schema":{"type":"string","description":"mon_..."}}],"responses":{"200":{"description":"The monitor, paused.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Monitor"},"examples":{"example1":{"summary":"Pause a monitor","value":{"id":"mon_0Lr8KtV3gH5bZy7pW2rXgE","object":"monitor","livemode":false,"status":"paused","pause_code":"by_request","schedule":"daily","mode":"link_check","client_domain":"example.com","pages":["https://news.example.org/2026/11/live-link-roastery"],"source_check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","notify_email":false,"next_run_at":null,"last_run_at":null,"last_check_id":null,"runs_completed":0,"ends_at":"2027-01-31T09:30:00Z","metadata":{},"created_at":"2026-11-02T09:30:00Z","ended_at":null,"project_id":null}}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error. The code is one of: monitor_not_active, monitor_ended.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"monitors:write","x-pressprove-idempotency":"none"}},"/monitors/{id}/resume":{"post":{"operationId":"resume-monitor","tags":["monitors"],"summary":"Resume a monitor","description":"Starts a paused monitor again. The next run is counted from now.\n\nTest mode: A test monitor runs once when you create it and again on POST /monitors/{id}/run. It never runs on its schedule.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the monitor.","schema":{"type":"string","description":"mon_..."}}],"responses":{"200":{"description":"The monitor, active.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Monitor"},"examples":{"example1":{"summary":"Resume a monitor","value":{"id":"mon_0Lr8KtV3gH5bZy7pW2rXgE","object":"monitor","livemode":false,"status":"active","pause_code":null,"schedule":"daily","mode":"link_check","client_domain":"example.com","pages":["https://news.example.org/2026/11/live-link-roastery"],"source_check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","notify_email":false,"next_run_at":null,"last_run_at":null,"last_check_id":null,"runs_completed":0,"ends_at":"2027-01-31T09:30:00Z","metadata":{},"created_at":"2026-11-02T09:30:00Z","ended_at":null,"project_id":null}}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Error. The code is one of: insufficient_balance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error. The code is one of: monitor_not_paused, monitor_ended.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"monitors:write","x-pressprove-idempotency":"none"}},"/monitors/{id}/run":{"post":{"operationId":"run-monitor","tags":["monitors"],"summary":"Run a test monitor now","description":"Test mode only. Runs the monitor once at once, so you can see a change without waiting for a schedule. Answers 202 with the check the run made, queued. A live key gets test_only_endpoint.\n\nTest mode: This endpoint exists only for test keys. On a page whose path contains flip, each run alternates the verdict, which makes a change.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the monitor.","schema":{"type":"string","description":"mon_..."}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Makes a retry safe: the same key with the same request returns the first answer. See Idempotency.","schema":{"type":"string","description":"1 to 255 printable ASCII characters.","minLength":1,"maxLength":255}}],"responses":{"202":{"description":"The check the run made, queued.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Check"},"examples":{"example1":{"summary":"Run a test monitor","value":{"id":"chk_0Lr8KsM9dE4zXv6oU1qWfD","object":"check","livemode":false,"status":"queued","mode":"link_check","kind":"recheck","source":"monitor","monitor_id":"mon_0Lr8KtV3gH5bZy7pW2rXgE","project_id":null,"client_domain":"example.com","page_count":1,"pages":[],"rejected":[],"summary":null,"credits":{"held":0,"charged":null,"free_pages":0},"failure_code":null,"metadata":{"monitor_id":"mon_0Lr8KtV3gH5bZy7pW2rXgE"},"created_at":"2026-11-02T09:30:00Z","started_at":null,"completed_at":null}}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope, test_only_endpoint.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error. The code is one of: monitor_not_active, monitor_ended.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"monitors:write","x-pressprove-idempotency":"recommended"}},"/monitors/{id}/changes":{"get":{"operationId":"list-monitor-changes","tags":["monitors"],"summary":"List a monitor's changes","description":"What changed between one run and the one before it, page by page, newest first. A change names the kind and shows the page before and after.\n\nTest mode: Use a page whose path contains flip, then run the monitor with POST /monitors/{id}/run to get changes. Other pages give an empty list.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the monitor.","schema":{"type":"string","description":"mon_..."}},{"name":"limit","in":"query","required":false,"description":"How many objects to return, 1 to 100. Default 20.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","required":false,"description":"The id of the last object you have. Returns the objects after it. Newest first.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of changes.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListMonitorChange"},"examples":{"example1":{"summary":"A monitor with no changes yet","value":{"object":"list","data":[],"has_more":false,"next_starting_after":null}}}}}},"400":{"description":"Error. The code is one of: limit_invalid, cursor_invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/reports":{"post":{"operationId":"create-report","tags":["reports"],"summary":"Create a proof report","description":"Turns a completed check into a dated proof report with your brand name, a share link and, where a PDF renderer is installed, a PDF. The report is dated by the check's completion time. The share link is unlisted: anyone with the address can read it. A live report also carries a record code (record_code): your client can type it at /verify to check that the report is genuine and still stands. That page shows the counts and dates printed on the report, never the page addresses or a link to the report.\n\nTest mode: A test report is a marked sample (sample is true), is not charged and has no PDF. Its share page says that no page was fetched and that it is not a proof report.","parameters":[{"name":"Idempotency-Key","in":"header","required":false,"description":"Makes a retry safe: the same key with the same request returns the first answer. See Idempotency.","schema":{"type":"string","description":"1 to 255 printable ASCII characters.","minLength":1,"maxLength":255}}],"responses":{"201":{"description":"The report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report"},"examples":{"example1":{"summary":"Report on a completed check","value":{"id":"rep_0Lr8KyB5mN7dBa9rY4tZiG","object":"report","livemode":false,"check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","dated":"2026-11-02T09:30:03Z","brand":{"name":"Harbor Lane Coffee","logo_url":null,"color":"#1d47c5"},"status":"ready","share_url":"https://pressprove.com/proof/9f3c1a7e5b2d4086a1c3e5f7092b4d68","pdf":{"status":"unavailable","url":null,"code":"test_mode_sample"},"sample":true,"record_code":null,"record_url":null,"verify_line":true,"credits_charged":0,"created_at":"2026-11-02T09:30:03Z","project_id":null}}}}}},"400":{"description":"Error. The code is one of: body_not_json, unknown_parameter, parameter_missing, brand_name_invalid, logo_url_invalid, brand_color_invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"402":{"description":"Error. The code is one of: insufficient_balance.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope, country_blocked, account_not_onboarded, live_mode_closed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error. The code is one of: check_not_completed.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited, reports_daily_limit, new_account_spend_limit.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"reports:write","x-pressprove-idempotency":"recommended","requestBody":{"required":true,"content":{"application/json":{"schema":{"$ref":"#/components/schemas/CreateReportInput"},"examples":{"example1":{"summary":"Report on a completed check","value":{"check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","brand":{"name":"Harbor Lane Coffee","color":"#1d47c5"}}}}}}}},"get":{"operationId":"list-reports","tags":["reports"],"summary":"List reports","description":"Your reports, newest first.\n\nTest mode: A test key lists test reports only.","parameters":[{"name":"limit","in":"query","required":false,"description":"How many objects to return, 1 to 100. Default 20.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","required":false,"description":"The id of the last object you have. Returns the objects after it. Newest first.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of reports.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListReport"},"examples":{"example1":{"summary":"Your reports","value":{"object":"list","data":[{"id":"rep_0Lr8KyB5mN7dBa9rY4tZiG","object":"report","livemode":false,"check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","dated":"2026-11-02T09:30:03Z","brand":{"name":"Harbor Lane Coffee","logo_url":null,"color":null},"status":"ready","share_url":"https://pressprove.com/proof/9f3c1a7e5b2d4086a1c3e5f7092b4d68","pdf":{"status":"unavailable","url":null,"code":"test_mode_sample"},"sample":true,"record_code":null,"record_url":null,"verify_line":true,"credits_charged":0,"created_at":"2026-11-02T09:30:03Z","project_id":null}],"has_more":false,"next_starting_after":null}}}}}},"400":{"description":"Error. The code is one of: limit_invalid, cursor_invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/reports/{id}":{"get":{"operationId":"retrieve-report","tags":["reports"],"summary":"Retrieve a report","description":"One report with its share link and the state of its PDF.\n\nTest mode: Same as create.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the report.","schema":{"type":"string","description":"rep_..."}}],"responses":{"200":{"description":"The report.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report"},"examples":{"example1":{"summary":"Read a report","value":{"id":"rep_0Lr8KyB5mN7dBa9rY4tZiG","object":"report","livemode":false,"check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","dated":"2026-11-02T09:30:03Z","brand":{"name":"Harbor Lane Coffee","logo_url":null,"color":null},"status":"ready","share_url":"https://pressprove.com/proof/9f3c1a7e5b2d4086a1c3e5f7092b4d68","pdf":{"status":"unavailable","url":null,"code":"test_mode_sample"},"sample":true,"record_code":null,"record_url":null,"verify_line":true,"credits_charged":0,"created_at":"2026-11-02T09:30:03Z","project_id":null}}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/reports/{id}/revoke":{"post":{"operationId":"revoke-report","tags":["reports"],"summary":"Revoke a report's share link","description":"Withdraws the share link. The share page and its PDF answer 404 from then on, and the report reads status revoked with no share_url. The charge does not change. A second call returns the revoked report. We also revoke an account's links when the account is frozen or a top-up is charged back. Revoking a link does not withdraw the report's record code: the report is still genuine.\n\nTest mode: A test report's share page is revoked the same way.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the report.","schema":{"type":"string","description":"rep_..."}},{"name":"Idempotency-Key","in":"header","required":false,"description":"Makes a retry safe: the same key with the same request returns the first answer. See Idempotency.","schema":{"type":"string","description":"1 to 255 printable ASCII characters.","minLength":1,"maxLength":255}}],"responses":{"200":{"description":"The report, revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Report"},"examples":{"example1":{"summary":"Revoke a share link","value":{"id":"rep_0Lr8KyB5mN7dBa9rY4tZiG","object":"report","livemode":false,"check_id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","dated":"2026-11-02T09:30:03Z","brand":{"name":"Harbor Lane Coffee","logo_url":null,"color":null},"status":"revoked","share_url":null,"pdf":{"status":"unavailable","url":null,"code":"test_mode_sample"},"sample":true,"record_code":null,"record_url":null,"verify_line":true,"credits_charged":0,"created_at":"2026-11-02T09:30:03Z","project_id":null}}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"reports:write","x-pressprove-idempotency":"recommended"}},"/reports/{id}/pdf":{"get":{"operationId":"download-report-pdf","tags":["reports"],"summary":"Download a report as PDF","description":"The report as application/pdf. Until the PDF is ready the answer is 409 pdf_not_ready. If no PDF renderer is installed, pdf.status reads unavailable and the share page can be printed to PDF from any browser.\n\nTest mode: A test report has no PDF, so this answers 409 pdf_not_ready.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the report.","schema":{"type":"string","description":"rep_..."}}],"responses":{"200":{"description":"The PDF file.","content":{"application/pdf":{"schema":{"type":"string","description":"application/pdf (binary)."}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"409":{"description":"Error. The code is one of: pdf_not_ready.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/balance":{"get":{"operationId":"retrieve-balance","tags":["balance"],"summary":"Retrieve the balance","description":"Your credits. available is what you can spend, held is already subtracted for checks in progress. A test key gets a note that test mode is not charged.\n\nTest mode: Always the not_charged note.","parameters":[],"responses":{"200":{"description":"The balance (live key) or the test-mode note (test key).","content":{"application/json":{"schema":{"oneOf":[{"$ref":"#/components/schemas/Balance"},{"$ref":"#/components/schemas/TestBalance"}]},"examples":{"example1":{"summary":"With a test key","value":{"object":"balance","livemode":false,"test_mode":"not_charged"}}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/usage":{"get":{"operationId":"retrieve-usage","tags":["balance"],"summary":"Retrieve usage","description":"Pages checked, re-checked, reports and credits spent, per UTC day. At most 92 days.\n\nTest mode: Test pages are counted in test_pages. Test mode spends no credits.","parameters":[{"name":"from","in":"query","required":false,"description":"First day. Default: 30 days before to.","schema":{"type":"string","description":"YYYY-MM-DD, UTC."}},{"name":"to","in":"query","required":false,"description":"Last day. Default: today.","schema":{"type":"string","description":"YYYY-MM-DD, UTC."}}],"responses":{"200":{"description":"Usage per day.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Usage"},"examples":{"example1":{"summary":"Two days","value":{"object":"usage","livemode":false,"from":"2026-11-01","to":"2026-11-02","days":[{"date":"2026-11-01","pages_checked":0,"pages_rechecked":0,"reports":0,"credits_spent":0,"test_pages":0},{"date":"2026-11-02","pages_checked":0,"pages_rechecked":0,"reports":0,"credits_spent":0,"test_pages":0}],"totals":{"pages_checked":0,"pages_rechecked":0,"reports":0,"credits_spent":0,"test_pages":0}}}}}}},"400":{"description":"Error. The code is one of: date_range_invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/ledger":{"get":{"operationId":"list-ledger","tags":["balance"],"summary":"List ledger entries","description":"Every change to your balance, newest first: top-ups, holds, returns and the rest. The ledger is append-only.\n\nTest mode: Empty: test mode writes no ledger.","parameters":[{"name":"limit","in":"query","required":false,"description":"How many objects to return, 1 to 100. Default 20.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","required":false,"description":"The id of the last object you have. Returns the objects after it. Newest first.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of ledger entries.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListLedgerEntry"},"examples":{"example1":{"summary":"With a test key","value":{"object":"list","data":[],"has_more":false,"next_starting_after":null}}}}}},"400":{"description":"Error. The code is one of: limit_invalid, cursor_invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/events":{"get":{"operationId":"list-events","tags":["events"],"summary":"List events","description":"The events of the last 30 days, newest first. These are the same events a webhook sends: poll here if you cannot receive webhooks.\n\nTest mode: A test key lists test events only.","parameters":[{"name":"type","in":"query","required":false,"description":"Only events of this type, such as check.completed.","schema":{"type":"string"}},{"name":"limit","in":"query","required":false,"description":"How many objects to return, 1 to 100. Default 20.","schema":{"type":"integer","minimum":1,"maximum":100,"default":20}},{"name":"starting_after","in":"query","required":false,"description":"The id of the last object you have. Returns the objects after it. Newest first.","schema":{"type":"string"}}],"responses":{"200":{"description":"A page of events.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ListApiEvent"},"examples":{"example1":{"summary":"Completed checks","value":{"object":"list","data":[{"id":"evt_0Lr8L1E8vT0gEd2uB7wClK","object":"event","type":"check.completed","livemode":false,"api_version":"v1","created":1793611803,"data":{"object":{"id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","object":"check","livemode":false,"status":"completed","mode":"link_check","kind":"check","source":"api","monitor_id":null,"project_id":null,"client_domain":"example.com","page_count":1,"rejected":[],"summary":{"verdicts":{"LINK_LIVE":1},"headline":{"verdict":"LINK_LIVE","pages":1,"distinct_domains":1}},"credits":{"held":0,"charged":0,"free_pages":0},"failure_code":null,"metadata":{},"created_at":"2026-11-02T09:30:00Z","started_at":"2026-11-02T09:30:02Z","completed_at":"2026-11-02T09:30:03Z"}}}],"has_more":false,"next_starting_after":null}}}}}},"400":{"description":"Error. The code is one of: event_type_unknown, limit_invalid, cursor_invalid.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}},"/events/{id}":{"get":{"operationId":"retrieve-event","tags":["events"],"summary":"Retrieve an event","description":"One event, within 30 days of when it happened.\n\nTest mode: A test key reads test events only.","parameters":[{"name":"id","in":"path","required":true,"description":"The id of the event.","schema":{"type":"string","description":"evt_..."}}],"responses":{"200":{"description":"The event.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/ApiEvent"},"examples":{"example1":{"summary":"A completed check","value":{"id":"evt_0Lr8L1E8vT0gEd2uB7wClK","object":"event","type":"check.completed","livemode":false,"api_version":"v1","created":1793611803,"data":{"object":{"id":"chk_0Lr8KpQ2aB3xYw5nT7pUeC","object":"check","livemode":false,"status":"completed","mode":"link_check","kind":"check","source":"api","monitor_id":null,"project_id":null,"client_domain":"example.com","page_count":1,"rejected":[],"summary":{"verdicts":{"LINK_LIVE":1},"headline":{"verdict":"LINK_LIVE","pages":1,"distinct_domains":1}},"credits":{"held":0,"charged":0,"free_pages":0},"failure_code":null,"metadata":{},"created_at":"2026-11-02T09:30:00Z","started_at":"2026-11-02T09:30:02Z","completed_at":"2026-11-02T09:30:03Z"}}}}}}}},"401":{"description":"Error. The code is one of: missing_api_key, invalid_api_key, api_key_revoked.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"403":{"description":"Error. The code is one of: missing_scope.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"404":{"description":"Error. The code is one of: not_found.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Error. The code is one of: rate_limited.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"500":{"description":"Error. The code is one of: internal_error.","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"security":[{"bearerAuth":[]}],"x-pressprove-scope":"read","x-pressprove-idempotency":"none"}}},"components":{"securitySchemes":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Authorization: Bearer pp_test_... or pp_live_..."}},"schemas":{"Error":{"type":"object","properties":{"error":{"type":"object","properties":{"type":{"type":"string","description":"The family of the error."},"code":{"type":"string","description":"Stable. Branch on this, never on the message."},"message":{"type":"string","description":"A sentence for a person."},"param":{"type":["string","null"],"description":"The parameter at fault, when one is."},"request_id":{"type":"string","description":"Quote this when you write to us."}},"required":["type","code","message","request_id"]}},"required":["error"]},"ObsString":{"description":"A text we saw, or the reason we could not.","oneOf":[{"type":"object","properties":{"known":{"type":"boolean","enum":[true]},"value":{"type":"string"}},"required":["known","value"]},{"type":"object","properties":{"known":{"type":"boolean","enum":[false]},"reason":{"type":"string","description":"Why we could not observe it."}},"required":["known","reason"]}]},"ObsBoolean":{"description":"A yes or no we saw, or the reason we could not.","oneOf":[{"type":"object","properties":{"known":{"type":"boolean","enum":[true]},"value":{"type":"boolean"}},"required":["known","value"]},{"type":"object","properties":{"known":{"type":"boolean","enum":[false]},"reason":{"type":"string","description":"Why we could not observe it."}},"required":["known","reason"]}]},"ObsInteger":{"description":"A number we saw, or the reason we could not.","oneOf":[{"type":"object","properties":{"known":{"type":"boolean","enum":[true]},"value":{"type":"integer"}},"required":["known","value"]},{"type":"object","properties":{"known":{"type":"boolean","enum":[false]},"reason":{"type":"string","description":"Why we could not observe it."}},"required":["known","reason"]}]},"ObsStringOrNull":{"description":"A text we saw (null when the page has none), or the reason we could not.","oneOf":[{"type":"object","properties":{"known":{"type":"boolean","enum":[true]},"value":{"type":["string","null"]}},"required":["known","value"]},{"type":"object","properties":{"known":{"type":"boolean","enum":[false]},"reason":{"type":"string","description":"Why we could not observe it."}},"required":["known","reason"]}]},"PageLink":{"type":"object","properties":{"href":{"type":"string"},"rel_raw":{"type":["string","null"],"description":"The rel attribute as written. null means the attribute is absent, which is not the same as empty."},"rel_tokens":{"type":"array","items":{"type":"string"}},"anchor_text":{"type":"string","description":"Up to 200 characters."},"zone":{"type":"string"}},"required":["href","rel_raw","rel_tokens","anchor_text","zone"]},"PageDisclosureMatch":{"type":"object","properties":{"term":{"type":"string"},"matched_text":{"type":"string","description":"Up to 200 characters."},"zone":{"type":"string"},"strength":{"type":"string","enum":["explicit","ambiguous"]}},"required":["term","matched_text","zone","strength"]},"PageResult":{"type":"object","properties":{"object":{"type":"string","enum":["page_result"]},"position":{"type":"integer","description":"0-based, in the order you sent the pages."},"url":{"type":"string","description":"The address you sent."},"verdict":{"type":["string","null"],"enum":["VERIFIED_LIVE","LIVE_NO_FINGERPRINT","NOT_LIVE","UNVERIFIABLE","LINK_LIVE","LIVE_NO_LINK",null],"description":"null only when the check failed before this page ran."},"fetched_at":{"type":["string","null"],"description":"When we fetched the page (UTC). This is the age of the result."},"reused":{"type":"boolean","description":"True when the result comes from a fetch made in the last 15 minutes."},"final_url":{"$ref":"#/components/schemas/ObsString"},"http_status":{"$ref":"#/components/schemas/ObsInteger"},"registrable_domain":{"$ref":"#/components/schemas/ObsString"},"text":{"type":"object","properties":{"found":{"$ref":"#/components/schemas/ObsBoolean"},"matched_phrase":{"$ref":"#/components/schemas/ObsStringOrNull"},"match_zone":{"$ref":"#/components/schemas/ObsStringOrNull"}},"required":["found","matched_phrase","match_zone"]},"links":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/ObsBoolean"},"count":{"$ref":"#/components/schemas/ObsInteger"},"rel_summary":{"$ref":"#/components/schemas/ObsStringOrNull"},"items":{"type":"array","items":{"$ref":"#/components/schemas/PageLink"},"description":"Up to 20 links to your domain."},"items_truncated":{"type":"boolean"}},"required":["present","count","rel_summary","items","items_truncated"]},"disclosure":{"type":"object","properties":{"present":{"$ref":"#/components/schemas/ObsBoolean"},"explicit":{"$ref":"#/components/schemas/ObsBoolean"},"prominence":{"$ref":"#/components/schemas/ObsStringOrNull"},"matches":{"type":"array","items":{"$ref":"#/components/schemas/PageDisclosureMatch"},"description":"Up to 10 labels found."}},"required":["present","explicit","prominence","matches"]},"noindex":{"$ref":"#/components/schemas/ObsBoolean"},"canonical_url":{"$ref":"#/components/schemas/ObsStringOrNull"},"published_at":{"$ref":"#/components/schemas/ObsStringOrNull"},"unknowns":{"type":"array","items":{"type":"object","properties":{"field":{"type":"string"},"reason":{"type":"string"}},"required":["field","reason"]},"description":"Every unknown above, by dotted field name."},"charged":{"type":"boolean","description":"Whether this page was billed."}},"required":["object","position","url","verdict","fetched_at","reused","final_url","http_status","registrable_domain","text","links","disclosure","noindex","canonical_url","published_at","unknowns","charged"]},"RejectedPage":{"type":"object","properties":{"input":{"type":"string"},"code":{"type":"string","description":"See page rejection codes on the Errors page."}},"required":["input","code"]},"CheckSummary":{"type":"object","properties":{"verdicts":{"type":"object","additionalProperties":{"type":"integer"},"description":"A count per verdict that occurred."},"headline":{"type":"object","properties":{"verdict":{"type":"string","enum":["VERIFIED_LIVE","LINK_LIVE"]},"pages":{"type":"integer"},"distinct_domains":{"type":"integer"}},"required":["verdict","pages","distinct_domains"]}},"required":["verdicts","headline"]},"Check":{"type":"object","properties":{"id":{"type":"string","description":"chk_..."},"object":{"type":"string","enum":["check"]},"livemode":{"type":"boolean"},"status":{"type":"string","enum":["queued","running","completed","failed","canceled"]},"mode":{"type":"string","enum":["text","link_check"]},"kind":{"type":"string","enum":["check","recheck"]},"source":{"type":"string","enum":["api","console","monitor"]},"monitor_id":{"type":["string","null"]},"client_domain":{"type":"string"},"page_count":{"type":"integer"},"project_id":{"type":["string","null"],"description":"The client project it is tagged to, in the same workspace; null when none."},"pages":{"type":"array","items":{"$ref":"#/components/schemas/PageResult"},"description":"Empty until the check has completed."},"rejected":{"type":"array","items":{"$ref":"#/components/schemas/RejectedPage"},"description":"Addresses refused at submission. Never charged."},"summary":{"oneOf":[{"$ref":"#/components/schemas/CheckSummary"},{"type":"null"}]},"credits":{"type":"object","properties":{"held":{"type":"integer"},"charged":{"oneOf":[{"type":"integer"},{"type":"null"}]},"free_pages":{"type":"integer"}},"required":["held","charged","free_pages"]},"failure_code":{"type":["string","null"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Your own notes: up to 20 keys, each key up to 40 characters, each value up to 500."},"created_at":{"type":"string"},"started_at":{"type":["string","null"]},"completed_at":{"type":["string","null"]}},"required":["id","object","livemode","status","mode","kind","source","monitor_id","client_domain","page_count","project_id","pages","rejected","summary","credits","failure_code","metadata","created_at","started_at","completed_at"]},"CheckSummaryObject":{"type":"object","properties":{"id":{"type":"string","description":"chk_..."},"object":{"type":"string","enum":["check"]},"livemode":{"type":"boolean"},"status":{"type":"string","enum":["queued","running","completed","failed","canceled"]},"mode":{"type":"string","enum":["text","link_check"]},"kind":{"type":"string","enum":["check","recheck"]},"source":{"type":"string","enum":["api","console","monitor"]},"monitor_id":{"type":["string","null"]},"client_domain":{"type":"string"},"page_count":{"type":"integer"},"project_id":{"type":["string","null"],"description":"The client project it is tagged to, in the same workspace; null when none."},"rejected":{"type":"array","items":{"$ref":"#/components/schemas/RejectedPage"},"description":"Addresses refused at submission. Never charged."},"summary":{"oneOf":[{"$ref":"#/components/schemas/CheckSummary"},{"type":"null"}]},"credits":{"type":"object","properties":{"held":{"type":"integer"},"charged":{"oneOf":[{"type":"integer"},{"type":"null"}]},"free_pages":{"type":"integer"}},"required":["held","charged","free_pages"]},"failure_code":{"type":["string","null"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Your own notes: up to 20 keys, each key up to 40 characters, each value up to 500."},"created_at":{"type":"string"},"started_at":{"type":["string","null"]},"completed_at":{"type":["string","null"]}},"required":["id","object","livemode","status","mode","kind","source","monitor_id","client_domain","page_count","project_id","rejected","summary","credits","failure_code","metadata","created_at","started_at","completed_at"],"description":"A check without its pages. Fetch them with GET /checks/{id}."},"Monitor":{"type":"object","properties":{"id":{"type":"string","description":"mon_..."},"object":{"type":"string","enum":["monitor"]},"livemode":{"type":"boolean"},"status":{"type":"string","enum":["active","paused","ended"]},"pause_code":{"type":["string","null"],"enum":["insufficient_balance","limit_reached","by_request","host_opted_out",null]},"schedule":{"type":"string","enum":["daily","weekly","day7_day30"]},"mode":{"type":"string","enum":["text","link_check"]},"client_domain":{"type":"string"},"pages":{"type":"array","items":{"type":"string"}},"source_check_id":{"type":["string","null"]},"notify_email":{"type":"boolean","description":"Email a summary when a page changes. Off by default for monitors made by API, on for monitors made in the console."},"next_run_at":{"type":["string","null"]},"last_run_at":{"type":["string","null"]},"last_check_id":{"type":["string","null"]},"runs_completed":{"type":"integer"},"ends_at":{"type":"string","description":"Every schedule has an end: daily 90 days, weekly 365 days, day7_day30 at day 30."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Your own notes: up to 20 keys, each key up to 40 characters, each value up to 500."},"created_at":{"type":"string"},"ended_at":{"type":["string","null"]},"project_id":{"type":["string","null"],"description":"The client project it is tagged to, in the same workspace; null when none."}},"required":["id","object","livemode","status","pause_code","schedule","mode","client_domain","pages","source_check_id","notify_email","next_run_at","last_run_at","last_check_id","runs_completed","ends_at","metadata","created_at","ended_at","project_id"]},"PageSnapshot":{"type":"object","properties":{"verdict":{"type":["string","null"],"enum":["VERIFIED_LIVE","LIVE_NO_FINGERPRINT","NOT_LIVE","UNVERIFIABLE","LINK_LIVE","LIVE_NO_LINK",null]},"http_status":{"$ref":"#/components/schemas/ObsInteger"},"rel_summary":{"$ref":"#/components/schemas/ObsStringOrNull"},"disclosure_present":{"$ref":"#/components/schemas/ObsBoolean"}},"required":["verdict","http_status","rel_summary","disclosure_present"]},"MonitorChange":{"type":"object","properties":{"id":{"type":"string","description":"chg_..."},"object":{"type":"string","enum":["monitor_change"]},"livemode":{"type":"boolean"},"monitor_id":{"type":"string"},"check_id":{"type":"string"},"previous_check_id":{"type":"string"},"url":{"type":"string"},"kind":{"type":"string","enum":["silent_removal","became_unverifiable","newly_verified","status_changed","rel_changed","disclosure_changed"]},"before":{"$ref":"#/components/schemas/PageSnapshot"},"after":{"$ref":"#/components/schemas/PageSnapshot"},"created_at":{"type":"string"}},"required":["id","object","livemode","monitor_id","check_id","previous_check_id","url","kind","before","after","created_at"]},"Report":{"type":"object","properties":{"id":{"type":"string","description":"rep_..."},"object":{"type":"string","enum":["report"]},"livemode":{"type":"boolean"},"check_id":{"type":"string"},"dated":{"type":"string","description":"The check's completed_at."},"brand":{"type":"object","properties":{"name":{"type":"string"},"logo_url":{"type":["string","null"]},"color":{"type":["string","null"]}},"required":["name","logo_url","color"]},"status":{"type":"string","enum":["ready","revoked"]},"share_url":{"type":["string","null"]},"pdf":{"type":"object","properties":{"status":{"type":"string","enum":["pending","ready","unavailable","failed"]},"url":{"type":["string","null"]},"code":{"type":["string","null"]}},"required":["status","url","code"]},"sample":{"type":"boolean","description":"True for every test-mode report: a marked sample, not a proof report."},"record_code":{"type":["string","null"],"description":"The record code printed on a live report, like PP-7K3M-9QX2-4T8F. Anyone holding it can check the report is genuine at /verify. Null in test mode."},"record_url":{"type":["string","null"],"description":"The public page that checks the record code: /verify/<record_code>. Null when record_code is null."},"verify_line":{"type":"boolean","description":"Whether the printed report carries the line \"Record <code> · Check it is genuine at pressprove.com/verify · Fingerprint\". When false the report names nothing of PressProve; the record still exists and record_code still checks."},"credits_charged":{"type":"integer"},"created_at":{"type":"string"},"project_id":{"type":["string","null"],"description":"The client project it is tagged to, in the same workspace; null when none."}},"required":["id","object","livemode","check_id","dated","brand","status","share_url","pdf","sample","record_code","record_url","verify_line","credits_charged","created_at","project_id"]},"Release":{"type":"object","properties":{"id":{"type":"string","description":"rel_..."},"object":{"type":"string","enum":["release"]},"livemode":{"type":"boolean"},"order_ref":{"type":["string","null"]},"package":{"type":"string","enum":["basic","standard","premium"]},"status":{"type":"string","enum":["in_review","draft_ready","changes_requested","approved","sent","live","report_ready","completed","rejected","refunded"]},"status_words":{"type":"string"},"company":{"type":"string"},"website":{"type":"string"},"headline":{"type":["string","null"]},"draft":{"oneOf":[{"type":"object","properties":{"text":{"type":"string"},"hash":{"type":"string"}},"required":["text","hash"]},{"type":"null"}]},"can_approve":{"type":"boolean"},"can_request_changes":{"type":"boolean"},"live_pages":{"type":"array","items":{"type":"string"}},"proof_reports":{"type":"array","items":{"type":"object","properties":{"day":{"type":"integer","enum":[0,7,30]},"url":{"type":["string","null"]},"status":{"type":"string","enum":["pending","ready"]}},"required":["day","url","status"]}},"credits_charged":{"type":"integer"},"refunded_to_balance":{"type":"boolean"},"created_at":{"type":"string"},"updated_at":{"type":"string"}},"required":["id","object","livemode","order_ref","package","status","status_words","company","website","headline","draft","can_approve","can_request_changes","live_pages","proof_reports","credits_charged","refunded_to_balance","created_at","updated_at"]},"Balance":{"type":"object","properties":{"object":{"type":"string","enum":["balance"]},"livemode":{"type":"boolean","enum":[true]},"available":{"type":"integer","description":"Credits you can spend. Never below 0."},"held":{"type":"integer","description":"Credits held for checks in progress, already subtracted."},"usd_value":{"type":"string","description":"available x 0.001, two decimals. For information."},"frozen":{"type":"boolean"},"expires_at":{"type":["string","null"]},"free_pages":{"type":"object","properties":{"per_month":{"type":"integer"},"used_this_month":{"type":"integer"}},"required":["per_month","used_this_month"]}},"required":["object","livemode","available","held","usd_value","frozen","expires_at","free_pages"]},"TestBalance":{"type":"object","properties":{"object":{"type":"string","enum":["balance"]},"livemode":{"type":"boolean","enum":[false]},"test_mode":{"type":"string","enum":["not_charged"]}},"required":["object","livemode","test_mode"]},"UsageDay":{"type":"object","properties":{"date":{"type":"string"},"pages_checked":{"type":"integer"},"pages_rechecked":{"type":"integer"},"reports":{"type":"integer"},"credits_spent":{"type":"integer"},"test_pages":{"type":"integer"}},"required":["date","pages_checked","pages_rechecked","reports","credits_spent","test_pages"]},"Usage":{"type":"object","properties":{"object":{"type":"string","enum":["usage"]},"livemode":{"type":"boolean"},"from":{"type":"string"},"to":{"type":"string"},"days":{"type":"array","items":{"$ref":"#/components/schemas/UsageDay"}},"totals":{"type":"object","properties":{"pages_checked":{"type":"integer"},"pages_rechecked":{"type":"integer"},"reports":{"type":"integer"},"credits_spent":{"type":"integer"},"test_pages":{"type":"integer"}},"required":["pages_checked","pages_rechecked","reports","credits_spent","test_pages"]}},"required":["object","livemode","from","to","days","totals"]},"LedgerEntry":{"type":"object","properties":{"id":{"type":"string","description":"led_..."},"object":{"type":"string","enum":["ledger_entry"]},"kind":{"type":"string","enum":["topup","topup_reversal","grant","hold","hold_return","publish","publish_refund","expiry","refund_unused"]},"amount":{"type":"integer","description":"Signed credits."},"subject":{"oneOf":[{"type":"object","properties":{"type":{"type":"string","enum":["check","report","release","topup","grant","account"]},"id":{"type":"string"}},"required":["type","id"]},{"type":"null"}]},"balance_after":{"type":"integer"},"created_at":{"type":"string"}},"required":["id","object","kind","amount","subject","balance_after","created_at"]},"ApiEvent":{"type":"object","properties":{"id":{"type":"string","description":"evt_..."},"object":{"type":"string","enum":["event"]},"type":{"type":"string","description":"See Events on the Webhooks page."},"livemode":{"type":"boolean"},"api_version":{"type":"string","enum":["v1"]},"created":{"type":"integer","description":"Unix time in seconds."},"data":{"type":"object","properties":{"object":{"type":"object","description":"The object the event is about."}},"required":["object"]}},"required":["id","object","type","livemode","api_version","created","data"]},"ApiInfo":{"type":"object","properties":{"object":{"type":"string","enum":["api"]},"version":{"type":"string","enum":["v1"]},"docs_url":{"type":"string"},"openapi_url":{"type":"string"}},"required":["object","version","docs_url","openapi_url"]},"PriceCard":{"type":"object","properties":{"currency":{"type":"string","enum":["USD"]},"credits_per_usd":{"type":"integer","enum":[1000]},"check":{"type":"object","properties":{"link_check":{"oneOf":[{"type":"integer"},{"type":"null"}]},"text":{"oneOf":[{"type":"integer"},{"type":"null"}]}},"required":["link_check","text"],"description":"Credits per page of a check, by mode. null until the price is set."},"monitor_run":{"type":"object","properties":{"link_check":{"oneOf":[{"type":"integer"},{"type":"null"}]},"text":{"oneOf":[{"type":"integer"},{"type":"null"}]}},"required":["link_check","text"],"description":"Credits per page of one monitor run, by mode. null until the price is set."},"report":{"oneOf":[{"type":"integer"},{"type":"null"}],"description":"Credits per proof report. null until the price is set."},"unverifiable_page":{"oneOf":[{"type":"integer"},{"type":"null"}],"description":"Credits per UNVERIFIABLE page beyond the free share. null until the price is set."},"unverifiable_free_share":{"type":"number","description":"UNVERIFIABLE pages are free up to this share of your live pages over 30 days."},"unverifiable_free_minimum":{"type":"integer","description":"...and never fewer than this many pages."},"release":{"type":"object","additionalProperties":{"type":"integer"},"description":"Credits per press release package."},"top_up_packs":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"usd":{"type":"integer"},"bonus_percent":{"type":"integer"},"credits":{"type":"integer"},"price_cents":{"type":"integer"}},"required":["id","usd","bonus_percent","credits","price_cents"]}},"minimum_top_up_usd":{"oneOf":[{"type":"integer"},{"type":"null"}],"description":"The smallest top-up in US dollars. null until it is set."},"free_live_link_checks_per_month":{"oneOf":[{"type":"integer"},{"type":"null"}],"description":"Free live pages a month, link-check mode only. null until it is set."},"placeholder":{"type":"boolean","description":"True only on a development server that shows stand-in prices."}},"required":["currency","credits_per_usd","check","monitor_run","report","unverifiable_page","unverifiable_free_share","unverifiable_free_minimum","release","top_up_packs","minimum_top_up_usd","free_live_link_checks_per_month","placeholder"]},"ListCheckSummary":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/CheckSummaryObject"}},"has_more":{"type":"boolean"},"next_starting_after":{"type":["string","null"],"description":"Pass this as starting_after to read the next page."}},"required":["object","data","has_more","next_starting_after"],"description":"A page of checks, newest first."},"ListMonitor":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Monitor"}},"has_more":{"type":"boolean"},"next_starting_after":{"type":["string","null"],"description":"Pass this as starting_after to read the next page."}},"required":["object","data","has_more","next_starting_after"],"description":"A page of monitors, newest first."},"ListMonitorChange":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/MonitorChange"}},"has_more":{"type":"boolean"},"next_starting_after":{"type":["string","null"],"description":"Pass this as starting_after to read the next page."}},"required":["object","data","has_more","next_starting_after"],"description":"A page of changes, newest first."},"ListReport":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Report"}},"has_more":{"type":"boolean"},"next_starting_after":{"type":["string","null"],"description":"Pass this as starting_after to read the next page."}},"required":["object","data","has_more","next_starting_after"],"description":"A page of reports, newest first."},"ListRelease":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/Release"}},"has_more":{"type":"boolean"},"next_starting_after":{"type":["string","null"],"description":"Pass this as starting_after to read the next page."}},"required":["object","data","has_more","next_starting_after"],"description":"A page of releases, newest first."},"ListLedgerEntry":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/LedgerEntry"}},"has_more":{"type":"boolean"},"next_starting_after":{"type":["string","null"],"description":"Pass this as starting_after to read the next page."}},"required":["object","data","has_more","next_starting_after"],"description":"A page of ledger entries, newest first."},"ListApiEvent":{"type":"object","properties":{"object":{"type":"string","enum":["list"]},"data":{"type":"array","items":{"$ref":"#/components/schemas/ApiEvent"}},"has_more":{"type":"boolean"},"next_starting_after":{"type":["string","null"],"description":"Pass this as starting_after to read the next page."}},"required":["object","data","has_more","next_starting_after"],"description":"A page of events, newest first."},"CreateCheckInput":{"type":"object","properties":{"pages":{"type":"array","items":{"type":"string","description":"http or https, up to 2,048 characters, no user name or password."},"description":"The pages to check (at least one). At most your account's pages per check (100 in test mode)."},"client_domain":{"type":"string","description":"Your website, such as example.com. We look for links to it."},"text":{"type":["string","null"],"description":"The text you placed, at least 40 words and at most 50,000 characters. Leave it out for a link check."},"mode":{"type":"string","enum":["auto","text","link_check"],"default":"auto","description":"auto: text given means text, otherwise link_check."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Your own notes: up to 20 keys, each key up to 40 characters, each value up to 500."},"project_id":{"type":["string","null"],"description":"Tag the check to one of your client projects (an id from the console). A project of another workspace answers not_found."}},"required":["pages","client_domain"]},"CreateMonitorInput":{"description":"Either check_id (copy the pages from a check), or pages and client_domain.","type":"object","properties":{"schedule":{"type":"string","enum":["daily","weekly","day7_day30"]},"check_id":{"type":"string","description":"Copy the pages, domain and mode from this completed check."},"pages":{"type":"array","items":{"type":"string"}},"client_domain":{"type":"string"},"text":{"type":["string","null"]},"mode":{"type":"string","enum":["auto","text","link_check"],"default":"auto"},"notify_email":{"type":"boolean","description":"Email a summary when a page changes. Default false through the API."},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Your own notes: up to 20 keys, each key up to 40 characters, each value up to 500."},"project_id":{"type":["string","null"],"description":"Tag the monitor, and every check it runs, to one of your client projects."}},"required":["schedule"]},"CreateReportInput":{"type":"object","properties":{"check_id":{"type":"string","description":"A completed check."},"brand":{"type":"object","properties":{"name":{"type":"string","description":"1 to 80 characters."},"logo_url":{"type":["string","null"],"description":"An https address."},"color":{"type":["string","null"],"description":"A hex color such as #1d47c5."}},"required":["name"]},"verify_line":{"type":"boolean","description":"Print the record line on the report. Default true. Send false to forward the report as your own: the record and its code still exist."},"project_id":{"type":["string","null"],"description":"Tag the report to one of your client projects. With no brand, the branding of the project and record-line default are used."}},"required":["check_id"]},"CreateReleaseInput":{"type":"object","properties":{"package":{"type":"string","enum":["basic","standard","premium"]},"company":{"type":"string"},"website":{"type":"string","description":"A public https address on your own domain."},"headline":{"type":"string"},"release_text":{"type":"string","description":"basic and standard: 250 to 400 words, written by you."},"brief":{"type":"string","description":"premium: what we should write from. The owner screens the draft."},"screen":{"type":"object","properties":{"refused_categories_absent":{"type":"boolean","enum":[true]},"links_controlled":{"type":"boolean","enum":[true]}},"required":["refused_categories_absent","links_controlled"]},"metadata":{"type":"object","additionalProperties":{"type":"string"},"description":"Your own notes: up to 20 keys, each key up to 40 characters, each value up to 500."}},"required":["package","company","website","screen"]},"ApproveReleaseInput":{"type":"object","properties":{"draft_hash":{"type":"string","description":"The hash of the draft you read, from release.draft.hash."}},"required":["draft_hash"]},"ReleaseChangesInput":{"type":"object","properties":{"changes":{"type":"string","description":"What to change. Up to 2,000 characters. Allowed once.","maxLength":2000}},"required":["changes"]}}}}
