{
  "info": {
    "name": "WebAutomation Datasets API",
    "description": "One generic API over every WebAutomation dataset. Set the `api_key` collection variable to your key (Account Settings \u2192 API Keys). `base_url` defaults to the production API. Billable endpoints (search, record, record/bulk) charge real credits.",
    "schema": "https://schema.getpostman.com/json/collection/v2.1.0/collection.json"
  },
  "variable": [
    {
      "key": "base_url",
      "value": "https://api.webautomation.io",
      "type": "string"
    },
    {
      "key": "api_key",
      "value": "",
      "type": "string"
    }
  ],
  "item": [
    {
      "name": "Account \u2014 plan, credits & limits (free)",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{api_key}}"
          }
        ],
        "url": {
          "raw": "{{base_url}}/v1/account",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "v1",
            "account"
          ]
        },
        "description": "Free. Returns your plan, remaining credits, per-endpoint costs and rate limits."
      }
    },
    {
      "name": "List datasets (free)",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{api_key}}"
          }
        ],
        "url": {
          "raw": "{{base_url}}/v1/datasets",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "v1",
            "datasets"
          ]
        },
        "description": "Free. Lists every dataset available through the API with its id, name and record count. Use the id in the other endpoints."
      }
    },
    {
      "name": "Dataset schema \u2014 filterable fields (free)",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{api_key}}"
          }
        ],
        "url": {
          "raw": "{{base_url}}/v1/datasets/344/schema",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "v1",
            "datasets",
            "344",
            "schema"
          ]
        },
        "description": "Free. The dataset's customer-facing fields, their types, whether they're filterable, and an example value. Read this before filtering, sorting or aggregating."
      }
    },
    {
      "name": "Count matching records (free)",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{api_key}}"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{base_url}}/v1/datasets/344/count",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "v1",
            "datasets",
            "344",
            "count"
          ]
        },
        "description": "Free. Total records in the dataset matching the filters. Cached ~5 minutes.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"filters\": {\n    \"product_rating\": {\n      \"gt\": 3\n    }\n  }\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Search records (bills per record)",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{api_key}}"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{base_url}}/v1/datasets/344/search",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "v1",
            "datasets",
            "344",
            "search"
          ]
        },
        "description": "Returns records matching the filters, optionally sorted. Bills 1 credit per record returned (pre-authorized at per_page). Use sort + per_page for 'top N by field'.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"filters\": {\n    \"category\": \"Books\"\n  },\n  \"page\": 1,\n  \"per_page\": 5,\n  \"sort\": \"product_rating:desc\"\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Enrich \u2014 one record by key (1 credit on match)",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{api_key}}"
          }
        ],
        "url": {
          "raw": "{{base_url}}/v1/datasets/344/record?",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "v1",
            "datasets",
            "344",
            "record"
          ],
          "query": [
            {
              "key": "url",
              "value": "https://www.linkedin.com/in/some-person",
              "description": "A key URL to look up (e.g. a LinkedIn profile/company URL).",
              "disabled": true
            },
            {
              "key": "domain",
              "value": "",
              "description": "A key domain to look up (dataset-dependent).",
              "disabled": true
            }
          ]
        },
        "description": "Look up the single best-matching record by one or more key fields passed as query params (e.g. ?url=... or ?domain=...). Generalizes company/person enrich to any dataset. 1 credit on a match; a miss is a free 404. LinkedIn URLs are matched regardless of scheme/case/trailing-slash."
      }
    },
    {
      "name": "Bulk enrich \u2014 up to 100 keys (bills per match)",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{api_key}}"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{base_url}}/v1/datasets/344/record/bulk",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "v1",
            "datasets",
            "344",
            "record",
            "bulk"
          ]
        },
        "description": "Match up to 100 values of one key field in a single call (the generic, any-dataset bulk enrich). 1 credit per match; misses are free. Results preserve input order; each item reports found.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"field\": \"linkedin_url\",\n  \"values\": [\n    \"https://www.linkedin.com/in/person-a\",\n    \"https://www.linkedin.com/in/person-b\"\n  ]\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    },
    {
      "name": "Facets \u2014 distinct values & counts (free)",
      "request": {
        "method": "GET",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{api_key}}"
          }
        ],
        "url": {
          "raw": "{{base_url}}/v1/datasets/344/facets?field=category",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "v1",
            "datasets",
            "344",
            "facets"
          ],
          "query": [
            {
              "key": "field",
              "value": "category",
              "description": "Field name(s) to facet (repeat for several).",
              "disabled": false
            },
            {
              "key": "limit",
              "value": "",
              "description": "Max values per field (default 50, max 500).",
              "disabled": true
            }
          ]
        },
        "description": "Free. Distinct values and their counts for one or more fields (default 50, cap 500). Powers filter UIs and value discovery."
      }
    },
    {
      "name": "Aggregate \u2014 group-by stats (free)",
      "request": {
        "method": "POST",
        "header": [
          {
            "key": "Authorization",
            "value": "Bearer {{api_key}}"
          },
          {
            "key": "Content-Type",
            "value": "application/json"
          }
        ],
        "url": {
          "raw": "{{base_url}}/v1/datasets/344/aggregate",
          "host": [
            "{{base_url}}"
          ],
          "path": [
            "v1",
            "datasets",
            "344",
            "aggregate"
          ]
        },
        "description": "Free. Group-by with metrics (count/avg/min/max/sum on numeric fields), with optional filters. Omit group_by for overall stats.",
        "body": {
          "mode": "raw",
          "raw": "{\n  \"group_by\": \"category\",\n  \"metrics\": [\n    {\n      \"op\": \"count\"\n    },\n    {\n      \"op\": \"avg\",\n      \"field\": \"product_rating\"\n    }\n  ],\n  \"limit\": 5\n}",
          "options": {
            "raw": {
              "language": "json"
            }
          }
        }
      }
    }
  ]
}