{"openapi":"3.1.0","info":{"title":"Judge.me (BYOK) API","version":"0.1.0","description":"Judge.me (BYOK) lets an AI assistant read your own Judge.me data through the Judge.me API with a key you supply (Judge.me private API token). Read-only: 8 tools (list_reviews, get_review, count_reviews, get_all_reviews_count, get_all_reviews_rating, get_shop_reviews_count, get_shop_reviews_rating, get_shop_info). The BYOK key travels with each request, is used for that one call only and is never...\n\nEvery operation is read-only or compute-only. The same tools are available over MCP (streamable HTTP) at https://byok-judgeme.connectorbay.com/mcp.","contact":{"name":"Unify Dynamics LLC","email":"agent@connectorbay.com","url":"https://connectorbay.com/byok-judgeme/docs"},"termsOfService":"https://connectorbay.com/byok-judgeme/terms"},"servers":[{"url":"https://byok-judgeme.connectorbay.com"}],"externalDocs":{"url":"https://connectorbay.com/byok-judgeme/docs"},"security":[{"upstreamKey":[]}],"components":{"securitySchemes":{"bearer":{"type":"http","scheme":"bearer","description":"Optional. A Pro API key raises rate limits; no credentials are required."},"upstreamKey":{"type":"apiKey","in":"header","name":"X-Upstream-Key","description":"Your own key for the service this connector wraps (bring your own key). Used for that one call only; never stored, logged or cached."}},"schemas":{"Error":{"type":"object","properties":{"ok":{"const":false},"error":{"type":"object"}}}}},"paths":{"/v1/tools/list_reviews":{"post":{"operationId":"list_reviews","summary":"List reviews of a shop, newest first, optionally for one product, one reviewer or one star rating. Reviewer email and ph","description":"List reviews of a shop, newest first, optionally for one product, one reviewer or one star rating. Reviewer email and phone are not returned. Use for \"Show the latest 1-star reviews in my Judge.me shop\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_domain":{"description":"The shop's domain as registered in Judge.me, for example 'example.myshopify.com'.","maxLength":100,"title":"Shop Domain","type":"string"},"product_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only reviews of this Judge.me internal product id.","title":"Product Id"},"reviewer_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only reviews by this Judge.me internal reviewer id.","title":"Reviewer Id"},"rating":{"anyOf":[{"enum":[1,2,3,4,5],"type":"integer"},{"type":"null"}],"default":null,"description":"Only reviews with this star rating.","title":"Rating"},"per_page":{"anyOf":[{"maximum":100,"minimum":1,"type":"integer"},{"type":"null"}],"default":10,"description":"How many reviews per page (this connector allows 1 to 100).","title":"Per Page"},"page":{"anyOf":[{"maximum":10000,"minimum":1,"type":"integer"},{"type":"null"}],"default":1,"description":"Page number, starting at 1.","title":"Page"}},"required":["shop_domain"],"title":"list_reviewsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_review":{"post":{"operationId":"get_review","summary":"Get one review by its Judge.me id: title, body, rating, product, source, dates and picture flags (reviewer email and pho","description":"Get one review by its Judge.me id: title, body, rating, product, source, dates and picture flags (reviewer email and phone are not returned). Use for \"Show Judge.me review 12345\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"id":{"description":"Judge.me internal review id from list_reviews.","title":"Id","type":"integer"},"shop_domain":{"description":"The shop's domain as registered in Judge.me, for example 'example.myshopify.com'.","maxLength":100,"title":"Shop Domain","type":"string"}},"required":["id","shop_domain"],"title":"get_reviewArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/count_reviews":{"post":{"operationId":"count_reviews","summary":"Count the shop's reviews, optionally for one product, one reviewer or one star rating. Use for \"How many 5-star reviews ","description":"Count the shop's reviews, optionally for one product, one reviewer or one star rating. Use for \"How many 5-star reviews does my Judge.me shop have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_domain":{"description":"The shop's domain as registered in Judge.me, for example 'example.myshopify.com'.","maxLength":100,"title":"Shop Domain","type":"string"},"product_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only reviews of this Judge.me internal product id.","title":"Product Id"},"reviewer_id":{"anyOf":[{"type":"integer"},{"type":"null"}],"default":null,"description":"Only reviews by this Judge.me internal reviewer id.","title":"Reviewer Id"},"rating":{"anyOf":[{"enum":[1,2,3,4,5],"type":"integer"},{"type":"null"}],"default":null,"description":"Only reviews with this star rating.","title":"Rating"}},"required":["shop_domain"],"title":"count_reviewsArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_all_reviews_count":{"post":{"operationId":"get_all_reviews_count","summary":"Get the total number of product and store reviews of the shop. Use for \"How many reviews in total does my Judge.me shop ","description":"Get the total number of product and store reviews of the shop. Use for \"How many reviews in total does my Judge.me shop have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_domain":{"description":"The shop's domain as registered in Judge.me, for example 'example.myshopify.com'.","maxLength":100,"title":"Shop Domain","type":"string"}},"required":["shop_domain"],"title":"get_all_reviews_countArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_all_reviews_rating":{"post":{"operationId":"get_all_reviews_rating","summary":"Get the average rating of all product and store reviews of the shop. Use for \"What is the average rating across all my J","description":"Get the average rating of all product and store reviews of the shop. Use for \"What is the average rating across all my Judge.me reviews\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_domain":{"description":"The shop's domain as registered in Judge.me, for example 'example.myshopify.com'.","maxLength":100,"title":"Shop Domain","type":"string"}},"required":["shop_domain"],"title":"get_all_reviews_ratingArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_shop_reviews_count":{"post":{"operationId":"get_shop_reviews_count","summary":"Get the total number of store-level reviews (not product reviews). Use for \"How many store-level reviews does my Judge.m","description":"Get the total number of store-level reviews (not product reviews). Use for \"How many store-level reviews does my Judge.me shop have\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_domain":{"description":"The shop's domain as registered in Judge.me, for example 'example.myshopify.com'.","maxLength":100,"title":"Shop Domain","type":"string"}},"required":["shop_domain"],"title":"get_shop_reviews_countArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_shop_reviews_rating":{"post":{"operationId":"get_shop_reviews_rating","summary":"Get the average rating of store-level reviews (not product reviews). Use for \"What is the average store-level rating on ","description":"Get the average rating of store-level reviews (not product reviews). Use for \"What is the average store-level rating on Judge.me\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_domain":{"description":"The shop's domain as registered in Judge.me, for example 'example.myshopify.com'.","maxLength":100,"title":"Shop Domain","type":"string"}},"required":["shop_domain"],"title":"get_shop_reviews_ratingArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}},"/v1/tools/get_shop_info":{"post":{"operationId":"get_shop_info","summary":"Get basic information about the shop in Judge.me such as its plan and e-commerce platform. Use for \"Which Judge.me plan ","description":"Get basic information about the shop in Judge.me such as its plan and e-commerce platform. Use for \"Which Judge.me plan is my shop on\".","tags":["tools"],"requestBody":{"required":true,"content":{"application/json":{"schema":{"properties":{"shop_domain":{"description":"The shop's domain as registered in Judge.me, for example 'example.myshopify.com'.","maxLength":100,"title":"Shop Domain","type":"string"}},"required":["shop_domain"],"title":"get_shop_infoArguments","type":"object"}}}},"responses":{"200":{"description":"Tool result. `ok: true` on success; `ok: false` with a structured `error` (provider_unavailable, upstream_error, bad_input) when the tool could not answer.","content":{"application/json":{"schema":{"type":"object","additionalProperties":true}}}},"422":{"description":"Arguments failed validation","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}},"429":{"description":"Rate limit exceeded (see Retry-After)","content":{"application/json":{"schema":{"$ref":"#/components/schemas/Error"}}}}},"x-read-only":true}}}}