{
  "openapi": "3.0.1",
  "info": {
    "title": "KB Search Query Tester",
    "description": "Test public knowledge base search queries and evaluate whether expected articles, titles, keywords, or categories appear in the top results.",
    "version": "1.0",
    "x-build-id": "OlFgGPBRqiWHiPtgg"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/junipr~kb-search-query-tester/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-junipr-kb-search-query-tester",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for its completion, and returns Actor's dataset items in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    },
    "/acts/junipr~kb-search-query-tester/runs": {
      "post": {
        "operationId": "runs-sync-junipr-kb-search-query-tester",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor and returns information about the initiated run in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/runsResponseSchema"
                }
              }
            }
          }
        }
      }
    },
    "/acts/junipr~kb-search-query-tester/run-sync": {
      "post": {
        "operationId": "run-sync-junipr-kb-search-query-tester",
        "x-openai-isConsequential": false,
        "summary": "Executes an Actor, waits for completion, and returns the OUTPUT from Key-value store in response.",
        "tags": [
          "Run Actor"
        ],
        "requestBody": {
          "required": true,
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/inputSchema"
              }
            }
          }
        },
        "parameters": [
          {
            "name": "token",
            "in": "query",
            "required": true,
            "schema": {
              "type": "string"
            },
            "description": "Enter your Apify token here"
          }
        ],
        "responses": {
          "200": {
            "description": "OK"
          }
        }
      }
    }
  },
  "components": {
    "schemas": {
      "inputSchema": {
        "type": "object",
        "properties": {
          "helpCenterBaseUrl": {
            "title": "Help Center Base URL",
            "type": "string",
            "description": "Public help center base URL to fetch or inspect for KB Search Query Tester.",
            "default": "https://support.zendesk.com/hc/en-us"
          },
          "searchUrlTemplate": {
            "title": "Search URL Template",
            "type": "string",
            "description": "Search URL Template controls KB Search Query Tester processing for the supplied inputs; keep values conservative for first runs.",
            "default": "https://support.zendesk.com/hc/en-us/search?query={query}"
          },
          "queries": {
            "title": "Queries",
            "type": "array",
            "description": "Search queries to run against the configured source or supplied content.",
            "items": {
              "type": "string"
            },
            "default": [
              "getting started"
            ]
          },
          "expectedResults": {
            "title": "Expected Results",
            "type": "object",
            "description": "Expected results used for comparison and validation.",
            "default": {
              "getting started": [
                "https://support.zendesk.com/hc/en-us/articles/4408884056346-Introduction-Getting-started-with-Zendesk-Support"
              ]
            },
            "additionalProperties": true
          },
          "expectedKeywords": {
            "title": "Expected Keywords",
            "type": "object",
            "description": "Expected keywords used for comparison and validation.",
            "default": {
              "getting started": [
                "getting",
                "started"
              ]
            },
            "additionalProperties": true
          },
          "resultSelectors": {
            "title": "Result Selectors",
            "type": "object",
            "description": "Selectors used to locate result in supplied or fetched HTML.",
            "default": {},
            "additionalProperties": true
          },
          "locale": {
            "title": "Locale",
            "type": "string",
            "description": "Locale controls KB Search Query Tester processing for the supplied inputs; keep values conservative for first runs.",
            "default": "en-us"
          },
          "maxResultsPerQuery": {
            "title": "Max Results Per Query",
            "type": "number",
            "description": "Maximum results per query to process in one run; keep defaults low for safe first runs.",
            "default": 5
          },
          "requestDelayMs": {
            "title": "Request Delay ms",
            "type": "number",
            "description": "Request Delay ms controls KB Search Query Tester processing for the supplied inputs; keep values conservative for first runs.",
            "default": 0
          },
          "includeSnippets": {
            "title": "Include Snippets",
            "type": "boolean",
            "description": "Include snippets in output rows or reports when available.",
            "default": true
          },
          "failOnMissingExpected": {
            "title": "Fail On Missing Expected",
            "type": "boolean",
            "description": "Fail On Missing Expected controls KB Search Query Tester processing for the supplied inputs; keep values conservative for first runs.",
            "default": false
          },
          "timeoutMs": {
            "title": "Timeout ms",
            "type": "number",
            "description": "Maximum time in milliseconds allowed for the KB Search Query Tester operation before it is treated as timed out.",
            "default": 15000
          },
          "maxChargeUsd": {
            "title": "Max Charge USD",
            "type": "number",
            "description": "Maximum estimated PPE charge allowed for the run before the actor stops gracefully.",
            "default": 1
          },
          "searchResultHtmlByQuery": {
            "title": "Search Result HTML by Query",
            "type": "object",
            "description": "Optional query-to-HTML map for deterministic search result testing without remote requests.",
            "default": {
              "getting started": "<a href=\"https://support.zendesk.com/hc/en-us/articles/4408884056346-Introduction-Getting-started-with-Zendesk-Support\">Introduction: Getting started with Zendesk Support</a><p>Zendesk Support getting-started tutorial.</p>",
              "knowledge base": "<a href=\"https://support.zendesk.com/hc/en-us/articles/4408839258778-Creating-articles-in-the-knowledge-base\">Creating articles in the knowledge base</a><p>Create and manage public knowledge base articles.</p>",
              "system requirements": "<a href=\"https://support.zendesk.com/hc/en-us/articles/4408893306010-Zendesk-Support-system-requirements\">Zendesk system requirements</a><p>Supported operating systems and browsers.</p>",
              "help center": "<a href=\"https://support.zendesk.com/hc/en-us/articles/4408846795674-Getting-started-with-your-help-center\">Getting started with your help center</a><p>Prepare and activate a public help center.</p>",
              "security": "<a href=\"https://support.zendesk.com/hc/en-us/articles/4408893306010-Zendesk-Support-system-requirements\">Zendesk system requirements</a><p>Review supported platforms before configuring security controls.</p>"
            },
            "additionalProperties": true
          }
        }
      },
      "runsResponseSchema": {
        "type": "object",
        "properties": {
          "data": {
            "type": "object",
            "properties": {
              "id": {
                "type": "string"
              },
              "actId": {
                "type": "string"
              },
              "userId": {
                "type": "string"
              },
              "startedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "finishedAt": {
                "type": "string",
                "format": "date-time",
                "example": "2025-01-08T00:00:00.000Z"
              },
              "status": {
                "type": "string",
                "example": "READY"
              },
              "meta": {
                "type": "object",
                "properties": {
                  "origin": {
                    "type": "string",
                    "example": "API"
                  },
                  "userAgent": {
                    "type": "string"
                  }
                }
              },
              "stats": {
                "type": "object",
                "properties": {
                  "inputBodyLen": {
                    "type": "integer",
                    "example": 2000
                  },
                  "rebootCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "restartCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "resurrectCount": {
                    "type": "integer",
                    "example": 0
                  },
                  "computeUnits": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "options": {
                "type": "object",
                "properties": {
                  "build": {
                    "type": "string",
                    "example": "latest"
                  },
                  "timeoutSecs": {
                    "type": "integer",
                    "example": 300
                  },
                  "memoryMbytes": {
                    "type": "integer",
                    "example": 1024
                  },
                  "diskMbytes": {
                    "type": "integer",
                    "example": 2048
                  }
                }
              },
              "buildId": {
                "type": "string"
              },
              "defaultKeyValueStoreId": {
                "type": "string"
              },
              "defaultDatasetId": {
                "type": "string"
              },
              "defaultRequestQueueId": {
                "type": "string"
              },
              "buildNumber": {
                "type": "string",
                "example": "1.0.0"
              },
              "containerUrl": {
                "type": "string"
              },
              "usage": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "integer",
                    "example": 1
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              },
              "usageTotalUsd": {
                "type": "number",
                "example": 0.00005
              },
              "usageUsd": {
                "type": "object",
                "properties": {
                  "ACTOR_COMPUTE_UNITS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATASET_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "KEY_VALUE_STORE_WRITES": {
                    "type": "number",
                    "example": 0.00005
                  },
                  "KEY_VALUE_STORE_LISTS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_READS": {
                    "type": "integer",
                    "example": 0
                  },
                  "REQUEST_QUEUE_WRITES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_INTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "DATA_TRANSFER_EXTERNAL_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_RESIDENTIAL_TRANSFER_GBYTES": {
                    "type": "integer",
                    "example": 0
                  },
                  "PROXY_SERPS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}