{"templateId":"markdown","sharedDataIds":{"sidebar":"sidebar-sidebars.yaml"},"props":{"metadata":{"markdoc":{"tagList":["admonition","partial","tabs","tab","code-snippet"]},"type":"markdown"},"seo":{"title":"Extract data with the Search API"},"dynamicMarkdocComponents":[],"compilationErrors":[],"ast":{"$$mdtype":"Tag","name":"article","attributes":{},"children":[{"$$mdtype":"Tag","name":"Heading","attributes":{"level":1,"id":"extract-data-with-the-search-api","__idx":0},"children":["Extract data with the Search API"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This playbook is for integrators and data teams who need a bulk extract from VBA, for example a nightly eligibility file for a vendor. It exports every enrollment row for one group, with member name, plan, and plan dates, to a CSV file, paging through the results 750 rows at a time."]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":""},"children":[]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Who this is for"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Data, reporting, and vendor-feed integrators"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Time to run"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["About 5 minutes, plus the time to page through your data"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Writes data?"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Only a search criteria record. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /criterias"]}," creates one, and the last step deletes it. The search itself only reads data."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Endpoints used"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["4"]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Before you start"},"children":[{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You have completed the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/get-started/quick-start"},"children":["quick start"]}," and can get an ID token."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You have read the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/search"},"children":["Search API concept page"]},", which explains SearchConfigs, criteria, and selected fields. This page does not repeat it."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["You know the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["group_ID"]}," to export. The samples use the placeholder ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DOCS-GRP1"]},"."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The CSV file holds member names and enrollment data. Store and transfer it like any other file containing personal health information."]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"how-it-fits-together","__idx":1},"children":["How it fits together"]},{"$$mdtype":"Tag","name":"Diagram","attributes":{"data-language":"mermaid","diagramType":"mermaid","diagramSource":"sequenceDiagram\n participant App as Your system\n participant API as VBAPI\n App->>API: GET /search-configs/ENROLLMENT\n API-->>App: Tables and fields this config can use\n App->>API: POST /criterias (Group_ID = DOCS-GRP1)\n API-->>App: criteria_Key\n loop page = 1, 2, 3 ... until a short page\n App->>API: POST /search (criteria_Key, selectedFields, page, pageCount 750)\n API-->>App: fieldMapping and results\n end\n App->>API: DELETE /criterias/{criteriaKey}\n","diagramHtml":"","diagramHtmlDark":""},"children":["sequenceDiagram\n participant App as Your system\n participant API as VBAPI\n App->>API: GET /search-configs/ENROLLMENT\n API-->>App: Tables and fields this config can use\n App->>API: POST /criterias (Group_ID = DOCS-GRP1)\n API-->>App: criteria_Key\n loop page = 1, 2, 3 ... until a short page\n App->>API: POST /search (criteria_Key, selectedFields, page, pageCount 750)\n API-->>App: fieldMapping and results\n end\n App->>API: DELETE /criterias/{criteriaKey}\n"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The samples read your credentials from environment variables:"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The samples read your credentials from environment variables, so nothing secret is written into code. Set them in the terminal you run the samples from:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"PowerShell","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"powershell","header":{"controls":{"copy":{}}},"source":"$env:VBAPI_BASE_URL = \"https://vbapi.vbasoftware.com/vbasoftware\"\n$env:VBAPI_API_KEY = \"your-api-key\"\n$env:VBAPI_CLIENT_ID = \"your-client-id\"\n$env:VBAPI_CLIENT_CODE = \"your-client-code\"\n$env:VBAPI_DATABASE = \"YOUR_DATABASE\"\n$env:VBAPI_USERNAME = \"your-api-username\"\n$env:VBAPI_PASSWORD = \"your-api-password\"\n$env:VBAPI_USER_AGENT = \"YourCompany-Integration/1.0\"\n","lang":"powershell"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"bash","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"bash","header":{"controls":{"copy":{}}},"source":"export VBAPI_BASE_URL=\"https://vbapi.vbasoftware.com/vbasoftware\"\nexport VBAPI_API_KEY=\"your-api-key\"\nexport VBAPI_CLIENT_ID=\"your-client-id\"\nexport VBAPI_CLIENT_CODE=\"your-client-code\"\nexport VBAPI_DATABASE=\"YOUR_DATABASE\"\nexport VBAPI_USERNAME=\"your-api-username\"\nexport VBAPI_PASSWORD=\"your-api-password\"\nexport VBAPI_USER_AGENT=\"YourCompany-Integration/1.0\"\n","lang":"bash"},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["In production code, load these from your secrets manager instead."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"steps","__idx":2},"children":["Steps"]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"1-check-the-searchconfig","__idx":3},"children":["1. Check the SearchConfig"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/search-config/getsearchconfig"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /search-configs/{searchConfigId}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["A SearchConfig defines which tables and columns a search can use. The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["ENROLLMENT"]}," config includes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Members"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SubEnrollment"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MemEnrollmentPlan"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Groups"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Plans"]},", and other enrollment tables (see the ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/reference/search-config-reference"},"children":["SearchConfig reference"]},"). SearchConfigs can differ between databases, so the samples first confirm that every column they select exists in yours. The API also rejects a search that selects a table or column the config does not include."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/SearchExtract.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var config = (await api.GetAsync($\"/search-configs/{SearchConfigId}\")).Data!;\n var available = config[\"tableConfigs\"]!.AsArray()\n .SelectMany(t => t![\"fields\"]!.AsArray().Select(f => $\"{t[\"name\"]}.{f![\"name\"]}\".ToLowerInvariant()))\n .ToHashSet();\n var missing = SelectedFields\n .Select(f => $\"{f.tableName}.{f.columnName}\")\n .Where(name => !available.Contains(name.ToLowerInvariant()))\n .ToList();\n if (missing.Count > 0)\n throw new InvalidOperationException($\"Not in {SearchConfigId} for this database: {string.Join(\", \", missing)}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/search_extract.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" config = api.get(f\"/search-configs/{SEARCH_CONFIG_ID}\").data\n available = {(t[\"name\"].lower(), f[\"name\"].lower()) for t in config[\"tableConfigs\"] for f in t[\"fields\"]}\n missing = [f\"{f['tableName']}.{f['columnName']}\" for f in SELECTED_FIELDS\n if (f[\"tableName\"].lower(), f[\"columnName\"].lower()) not in available]\n if missing:\n raise SystemExit(f\"Not in {SEARCH_CONFIG_ID} for this database: {', '.join(missing)}\")\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/searchExtract.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const config = (await api.get(`/search-configs/${SEARCH_CONFIG_ID}`)).data;\n const available = new Set(\n config.tableConfigs.flatMap((t: any) => t.fields.map((f: any) => `${t.name}.${f.name}`.toLowerCase())),\n );\n const missing = SELECTED_FIELDS.map((f) => `${f.tableName}.${f.columnName}`).filter((name) => !available.has(name.toLowerCase()));\n if (missing.length > 0) throw new Error(`Not in ${SEARCH_CONFIG_ID} for this database: ${missing.join(\", \")}`);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The samples select these columns:"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Table"},"children":["Table"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Column"},"children":["Column"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Sorted"},"children":["Sorted"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Members"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Subscriber_ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["1st"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Members"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Member_Seq"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["2nd"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Members"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["First_Name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Members"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Last_Name"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MemEnrollmentPlan"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Plan_ID"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["3rd"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MemEnrollmentPlan"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Plan_Start"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["4th"]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MemEnrollmentPlan"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Plan_End"]}]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[]}]}]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Sort on columns that together identify a row, as here, so the order is the same on every page you request."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"2-create-the-criteria","__idx":4},"children":["2. Create the criteria"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/criteria/createcriteria"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /criterias"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["This is the one write in the playbook: it saves a criteria record that filters on the group. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["temporary: true"]}," keeps it out of the saved searches list. ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["criteria_Operator"]}," and the values are combined into the search's filter, so use a plain comparison such as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["="]}," and set ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["criteria_Data_Type"]}," to ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["string"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["date"]},", or ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["number"]},"."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/SearchExtract.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var criteria = new\n {\n searchConfigId = SearchConfigId,\n criteria_Type = SearchConfigId,\n description = $\"DOCS extract for group {GroupId}\",\n temporary = true, // not kept as a saved search\n criteriaDetails = new[]\n {\n new\n {\n criteria_Seq = 1,\n criteria_Table = \"SubEnrollment\",\n criteria_Column = \"Group_ID\",\n criteria_Data_Type = \"string\",\n criteria_Operator = \"=\",\n criteria_From_Value = GroupId,\n },\n },\n };\n var criteriaKey = (await api.PostAsync(\"/criterias\", criteria)).Data![\"criteria_Key\"]!.GetValue();\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/search_extract.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" criteria = {\n \"searchConfigId\": SEARCH_CONFIG_ID,\n \"criteria_Type\": SEARCH_CONFIG_ID,\n \"description\": f\"DOCS extract for group {GROUP_ID}\",\n \"temporary\": True, # not kept as a saved search\n \"criteriaDetails\": [\n {\n \"criteria_Seq\": 1,\n \"criteria_Table\": \"SubEnrollment\",\n \"criteria_Column\": \"Group_ID\",\n \"criteria_Data_Type\": \"string\",\n \"criteria_Operator\": \"=\",\n \"criteria_From_Value\": GROUP_ID,\n }\n ],\n }\n criteria_key = api.post(\"/criterias\", criteria).data[\"criteria_Key\"]\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/searchExtract.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" const criteria = {\n searchConfigId: SEARCH_CONFIG_ID,\n criteria_Type: SEARCH_CONFIG_ID,\n description: `DOCS extract for group ${GROUP_ID}`,\n temporary: true, // not kept as a saved search\n criteriaDetails: [\n {\n criteria_Seq: 1,\n criteria_Table: \"SubEnrollment\",\n criteria_Column: \"Group_ID\",\n criteria_Data_Type: \"string\",\n criteria_Operator: \"=\",\n criteria_From_Value: GROUP_ID,\n },\n ],\n };\n const criteriaKey: number = (await api.post(\"/criterias\", criteria)).data.criteria_Key;\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The request body, as JSON:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"searchConfigId\": \"ENROLLMENT\",\n \"criteria_Type\": \"ENROLLMENT\",\n \"description\": \"DOCS extract for group DOCS-GRP1\",\n \"temporary\": true,\n \"criteriaDetails\": [\n {\n \"criteria_Seq\": 1,\n \"criteria_Table\": \"SubEnrollment\",\n \"criteria_Column\": \"Group_ID\",\n \"criteria_Data_Type\": \"string\",\n \"criteria_Operator\": \"=\",\n \"criteria_From_Value\": \"DOCS-GRP1\"\n }\n ]\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Save from the response:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["data.criteria_Key"]}," (used in steps 3 and 5)."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"3-page-through-the-results","__idx":5},"children":["3. Page through the results"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/search-request/searchrequest"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /search"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["criteria_Key"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchConfigId"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["selectedFields"]}," are required. Paging works like this:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["page"]}," starts at 1. Page 0 is accepted but also returns the first page, so a loop that starts at 0 reads the first page twice."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageCount"]}," is the number of rows per page. It defaults to 750, and the API rejects values above 750."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Stop when a page returns fewer rows than ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageCount"]},". That is the last page."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Pagination"]}," response header is only accurate when the request sets ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["include_Result_Details: true"]},". Without it, ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TotalCount"]}," is ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["0"]},". The samples do not need totals, so they do not set it."]}]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/SearchExtract.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" var total = 0;\n await using (var writer = new StreamWriter(OutputFile))\n {\n for (var page = 1; ; page++) // pages start at 1; page 0 also returns the first page, so never start at 0\n {\n var result = (await api.PostAsync(\"/search\", new\n {\n criteria_Key = criteriaKey,\n searchConfigId = SearchConfigId,\n selectedFields = SelectedFields,\n page,\n pageCount = PageCount,\n })).Data!;\n var rows = WritePage(writer, result, includeHeader: page == 1);\n total += rows;\n if (rows < PageCount)\n break; // a short page is the last page\n }\n }\n Console.WriteLine($\"Wrote {total} rows to {OutputFile}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/search_extract.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" total = 0\n with OUTPUT_FILE.open(\"w\", newline=\"\", encoding=\"utf-8\") as output:\n writer = csv.writer(output)\n page = 1 # pages start at 1; page 0 also returns the first page, so never start at 0\n while True:\n result = api.post(\"/search\", {\n \"criteria_Key\": criteria_key,\n \"searchConfigId\": SEARCH_CONFIG_ID,\n \"selectedFields\": SELECTED_FIELDS,\n \"page\": page,\n \"pageCount\": PAGE_COUNT,\n }).data\n rows = write_page(writer, result, include_header=(page == 1))\n total += rows\n if rows < PAGE_COUNT:\n break # a short page is the last page\n page += 1\n print(f\"Wrote {total} rows to {OUTPUT_FILE}\")\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/searchExtract.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" let total = 0;\n const output = createWriteStream(OUTPUT_FILE, { encoding: \"utf-8\" });\n for (let page = 1; ; page++) {\n // pages start at 1; page 0 also returns the first page, so never start at 0\n const result = (\n await api.post(\"/search\", {\n criteria_Key: criteriaKey,\n searchConfigId: SEARCH_CONFIG_ID,\n selectedFields: SELECTED_FIELDS,\n page,\n pageCount: PAGE_COUNT,\n })\n ).data;\n const rows = writePage(output, result, page === 1);\n total += rows;\n if (rows < PAGE_COUNT) break; // a short page is the last page\n }\n await new Promise((resolve, reject) => output.end((error?: Error | null) => (error ? reject(error) : resolve())));\n console.log(`Wrote ${total} rows to ${OUTPUT_FILE}`);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each call sends a body like this one:"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"criteria_Key\": 12345,\n \"searchConfigId\": \"ENROLLMENT\",\n \"selectedFields\": [\n { \"tableName\": \"Members\", \"columnName\": \"Subscriber_ID\", \"sortPriority\": 1 },\n { \"tableName\": \"Members\", \"columnName\": \"Member_Seq\", \"sortPriority\": 2 },\n { \"tableName\": \"Members\", \"columnName\": \"First_Name\" },\n { \"tableName\": \"Members\", \"columnName\": \"Last_Name\" },\n { \"tableName\": \"MemEnrollmentPlan\", \"columnName\": \"Plan_ID\", \"sortPriority\": 3 },\n { \"tableName\": \"MemEnrollmentPlan\", \"columnName\": \"Plan_Start\", \"sortPriority\": 4 },\n { \"tableName\": \"MemEnrollmentPlan\", \"columnName\": \"Plan_End\" }\n ],\n \"page\": 1,\n \"pageCount\": 750\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"4-write-the-rows-to-csv","__idx":6},"children":["4. Write the rows to CSV"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Each result has ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldMapping"]},", which names the table and column for each position, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["results"]},", an array of rows where each row is an array of values. Use ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["fieldMapping[].columnIndex"]}," to find each column's value in a row rather than assuming the rows follow the order of ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["selectedFields"]},"."]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Example response (illustrative; field values are fake, and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search_SQL_Statement"]}," is shortened):"]},{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"data-language":"json","header":{"controls":{"copy":{}}},"source":"{\n \"data\": {\n \"searchConfigId\": \"ENROLLMENT\",\n \"criteria_Key\": 12345,\n \"search_SQL_Statement\": \"SELECT ...\",\n \"fieldMapping\": [\n { \"tableName\": \"Members\", \"columnName\": \"Subscriber_ID\", \"columnIndex\": 0 },\n { \"tableName\": \"Members\", \"columnName\": \"Member_Seq\", \"columnIndex\": 1 },\n { \"tableName\": \"Members\", \"columnName\": \"First_Name\", \"columnIndex\": 2 },\n { \"tableName\": \"Members\", \"columnName\": \"Last_Name\", \"columnIndex\": 3 },\n { \"tableName\": \"MemEnrollmentPlan\", \"columnName\": \"Plan_ID\", \"columnIndex\": 4 },\n { \"tableName\": \"MemEnrollmentPlan\", \"columnName\": \"Plan_Start\", \"columnIndex\": 5 },\n { \"tableName\": \"MemEnrollmentPlan\", \"columnName\": \"Plan_End\", \"columnIndex\": 6 }\n ],\n \"results\": [\n [\"DOCS-0001\", \"01\", \"Sample\", \"Member\", \"DOCS-PLN1\", \"2030-01-01T00:00:00\", null],\n [\"DOCS-0001\", \"02\", \"Sample\", \"Dependent\", \"DOCS-PLN1\", \"2030-01-01T00:00:00\", null]\n ]\n },\n \"error\": null,\n \"debug\": { \"activityID\": \"00000000-0000-0000-0000-000000000000\" }\n}\n","lang":"json"},"children":[]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The samples write one header row (",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Members.Subscriber_ID"]},", ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["Members.Member_Seq"]},", and so on) and then each row, quoting values that contain commas, quotes, or line breaks:"]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/SearchExtract.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" static int WritePage(StreamWriter writer, JsonNode result, bool includeHeader)\n {\n // fieldMapping says which row position holds each column.\n var columns = result[\"fieldMapping\"]!.AsArray()\n .OrderBy(m => m![\"columnIndex\"]!.GetValue())\n .ToList();\n if (includeHeader)\n writer.WriteLine(string.Join(\",\", columns.Select(m => Csv($\"{m![\"tableName\"]}.{m[\"columnName\"]}\"))));\n var rows = result[\"results\"]!.AsArray();\n foreach (var row in rows)\n writer.WriteLine(string.Join(\",\", columns.Select(m => Csv(row![m![\"columnIndex\"]!.GetValue()]?.ToString()))));\n return rows.Count;\n }\n\n static string Csv(string? value) =>\n value is null ? \"\" : value.IndexOfAny(new[] { ',', '\"', '\\n', '\\r' }) >= 0 ? $\"\\\"{value.Replace(\"\\\"\", \"\\\"\\\"\")}\\\"\" : value;\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/search_extract.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":"def write_page(writer, result, include_header):\n \"\"\"Write one page of search results. fieldMapping says which row position holds each column.\"\"\"\n columns = sorted(result[\"fieldMapping\"], key=lambda m: m[\"columnIndex\"])\n if include_header:\n writer.writerow(f\"{m['tableName']}.{m['columnName']}\" for m in columns)\n for row in result[\"results\"]:\n writer.writerow(row[m[\"columnIndex\"]] for m in columns)\n return len(result[\"results\"])"},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/searchExtract.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":"function csv(value: unknown): string {\n if (value === null || value === undefined) return \"\";\n const text = String(value);\n return /[\",\\r\\n]/.test(text) ? `\"${text.replace(/\"/g, '\"\"')}\"` : text;\n}\n\n/** Write one page of search results. fieldMapping says which row position holds each column. */\nfunction writePage(output: WriteStream, result: SearchResult, includeHeader: boolean): number {\n const columns = [...result.fieldMapping].sort((a, b) => a.columnIndex - b.columnIndex);\n if (includeHeader) output.write(columns.map((m) => csv(`${m.tableName}.${m.columnName}`)).join(\",\") + \"\\n\");\n for (const row of result.results) output.write(columns.map((m) => csv(row[m.columnIndex])).join(\",\") + \"\\n\");\n return result.results.length;\n}"},"children":[]}]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":3,"id":"5-delete-the-criteria","__idx":7},"children":["5. Delete the criteria"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/criteria/deletecriteria"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["DELETE /criterias/{criteriaKey}"]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The samples delete the criteria they created, even if the search fails part-way. A delete returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["204"]}," with no body."]},{"$$mdtype":"Tag","name":"Tabs","attributes":{"size":"medium"},"children":[{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"C#","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/SearchExtract.cs","language":"csharp","header":{"controls":{"copy":{}}},"lang":"csharp","source":" await api.DeleteAsync($\"/criterias/{criteriaKey}\");\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"Python","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/search_extract.py","language":"python","header":{"controls":{"copy":{}}},"lang":"python","source":" api.delete(f\"/criterias/{criteria_key}\")\n "},"children":[]}]},{"$$mdtype":"Tag","name":"TabItemFragment","attributes":{"label":"TypeScript","disable":false},"children":[{"$$mdtype":"Tag","name":"CodeBlock","attributes":{"file":"../../_samples/playbooks/search-extract/searchExtract.ts","language":"typescript","header":{"controls":{"copy":{}}},"lang":"typescript","source":" await api.delete(`/criterias/${criteriaKey}`);\n "},"children":[]}]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":[{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/criteria/cleanupcriteria"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /cleanup-criteria"]}]}," is a different, administrative operation: it trims all temporary criteria in the database down to the count set in the Control Panel and returns ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["202"]},". An extract does not need it."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"verify-the-result","__idx":8},"children":["Verify the result"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Open the CSV and check that the header row lists the seven columns and that the row count printed by the sample matches what you expect for the group. To get the total from the API, run one search with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["include_Result_Details: true"]}," and an explicit ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageCount"]},", and read ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["TotalCount"]}," from the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["X-Pagination"]}," header."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"common-errors","__idx":9},"children":["Common errors"]},{"$$mdtype":"Tag","name":"div","attributes":{"className":"md-table-wrapper"},"children":[{"$$mdtype":"Tag","name":"table","attributes":{"className":"md"},"children":[{"$$mdtype":"Tag","name":"thead","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Symptom"},"children":["Symptom"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Likely cause"},"children":["Likely cause"]},{"$$mdtype":"Tag","name":"th","attributes":{"data-label":"Fix"},"children":["Fix"]}]}]},{"$$mdtype":"Tag","name":"tbody","attributes":{},"children":[{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"For API calls, PageCount cannot exceed 750 records\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["pageCount"]}," is above 750."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Use 750 or less."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Table: ... is not valid for this search\" or \"Column: ... is not valid for this search\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["A selected field is not in the SearchConfig for your database."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Check the config with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /search-configs/{searchConfigId}"]}," and pick columns it lists."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["\"Field List sent in Search Request may not be empty\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["selectedFields"]}," is empty."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Select at least one column."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["404"]},", or \"Criteria Key ... provided in the Search Request is invalid\""]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["criteria_Key"]}," does not exist, for example because it was deleted."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Create the criteria again."]}]},{"$$mdtype":"Tag","name":"tr","attributes":{},"children":[{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The first page appears twice in the file"]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["The loop started at page 0."]},{"$$mdtype":"Tag","name":"td","attributes":{},"children":["Start at page 1."]}]}]}]}]},{"$$mdtype":"Tag","name":"Admonition","attributes":{"type":"info","name":"Contacting support"},"children":[{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Send VBA support:"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["debug.activityID"]}," from the response"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the date and time of the call, with time zone"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the method and path, for example ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["POST /claim-batches"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the full ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["error"]}," object from the response"]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["the request body, with passwords, tokens, and personal data removed"]}]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["Never send your password, API key, or tokens. See ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/help/support"},"children":["Support and escalation"]},"."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"variations","__idx":10},"children":["Variations"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["No criteria record:"]}," ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SearchRequest"]}," also accepts the filter inline. Send ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["criteria_Key: 0"]}," and put the criteria details in ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["criterias"]},"; the API then skips the criteria lookup and passes the inline details to the search. This avoids the write in step 2, but needs confirmation against the live API before you rely on it."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Check the filter:"]}," ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/openapi/vbasoftware/vbasoftware.api/criteria/getcriteriawhereclause"},"children":[{"$$mdtype":"Tag","name":"code","attributes":{},"children":["GET /criterias-where-clause/{criteriaKey}"]}]}," returns the filter that a saved criteria produces, which helps when a search returns no rows."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Only active enrollments:"]}," add a second criteria detail on ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["MemEnrollmentPlan.Plan_End"]}," (for example, empty or after today) joined with ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["criteria_AndOr"]},". The right definition of \"active\" for your clients needs SME confirmation."]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":[{"$$mdtype":"Tag","name":"strong","attributes":{},"children":["Safe to re-run?"]}," Yes. The search only reads data, and each run creates and deletes its own criteria. Each run overwrites the CSV file."]}]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"download","__idx":11},"children":["Download"]},{"$$mdtype":"Tag","name":"p","attributes":{},"children":["The full runnable samples are in the portal repository under ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["_samples/playbooks/search-extract/"]},": ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SearchExtract.cs"]}," (run with the shared C# runner as ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["SearchExtractPlaybook"]},"), ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["search_extract.py"]},", and ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["searchExtract.ts"]},". Each uses the shared client helper for its language and writes ",{"$$mdtype":"Tag","name":"code","attributes":{},"children":["enrollments.csv"]}," in the current folder."]},{"$$mdtype":"Tag","name":"Heading","attributes":{"level":2,"id":"related","__idx":12},"children":["Related"]},{"$$mdtype":"Tag","name":"ul","attributes":{},"children":[{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Concepts: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/search"},"children":["Search API"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/pagination-and-sorting"},"children":["Pagination and sorting"]},", ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/concepts/rate-limits-and-performance"},"children":["Rate limits and performance"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Reference: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/reference/search-config-reference"},"children":["SearchConfig reference"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Previous playbook: ",{"$$mdtype":"Tag","name":"MarkdownLink","attributes":{"href":"/developer-portal/playbooks/disenroll-member"},"children":["Disenroll a member or group"]}]},{"$$mdtype":"Tag","name":"li","attributes":{},"children":["Ask the AI: \"Using the Extract data with the Search API playbook, write a TypeScript function that exports all claims for one group to CSV.\""]}]}]},"headings":[{"value":"Extract data with the Search API","id":"extract-data-with-the-search-api","depth":1},{"value":"How it fits together","id":"how-it-fits-together","depth":2},{"value":"Steps","id":"steps","depth":2},{"value":"1. Check the SearchConfig","id":"1-check-the-searchconfig","depth":3},{"value":"2. Create the criteria","id":"2-create-the-criteria","depth":3},{"value":"3. Page through the results","id":"3-page-through-the-results","depth":3},{"value":"4. Write the rows to CSV","id":"4-write-the-rows-to-csv","depth":3},{"value":"5. Delete the criteria","id":"5-delete-the-criteria","depth":3},{"value":"Verify the result","id":"verify-the-result","depth":2},{"value":"Common errors","id":"common-errors","depth":2},{"value":"Variations","id":"variations","depth":2},{"value":"Download","id":"download","depth":2},{"value":"Related","id":"related","depth":2}],"frontmatter":{"title":"Extract data with the Search API","description":"Export enrollment rows for one group to a CSV file with VBAPI's Search API, paging safely through large result sets.","seo":{"title":"Extract data with the Search API"}},"lastModified":"2026-10-26T21:09:33.694Z","pagePropGetterError":{"message":"","name":""}},"slug":"/developer-portal/playbooks/search-extract","userData":{"isAuthenticated":false,"teams":["anonymous"]},"isPublic":true}