Franchise Page Inventory
Pricing
from $4.90 / 1,000 page auditeds
Go to Apify Store
Franchise Page Inventory
Inventory franchise or multi-location website pages, location URLs, and page coverage.
Franchise Page Inventory
Pricing
from $4.90 / 1,000 page auditeds
Inventory franchise or multi-location website pages, location URLs, and page coverage.
You can access the Franchise Page Inventory programmatically from your own applications by using the Apify API. You can also choose the language preference from below. To use the Apify API, you’ll need an Apify account and your API token, found in Integrations settings in Apify Console.
{ "openapi": "3.0.1", "info": { "version": "1.0", "x-build-id": "w7f3bNJiWAU6aURmQ" }, "servers": [ { "url": "https://api.apify.com/v2" } ], "paths": { "/acts/junipr~franchise-page-inventory/run-sync-get-dataset-items": { "post": { "operationId": "run-sync-get-dataset-items-junipr-franchise-page-inventory", "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~franchise-page-inventory/runs": { "post": { "operationId": "runs-sync-junipr-franchise-page-inventory", "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~franchise-page-inventory/run-sync": { "post": { "operationId": "run-sync-junipr-franchise-page-inventory", "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": { "targets": { "title": "Franchise sources", "maxItems": 50, "type": "array", "description": "Source objects to inspect for this run.", "items": { "type": "object", "additionalProperties": false, "properties": { "sourceId": { "type": "string", "title": "Source ID", "description": "Stable identifier for this source or record." }, "sourceUrl": { "type": "string", "title": "Source URL", "description": "Public source URL for this item." }, "title": { "type": "string", "title": "Title", "description": "Title for this item." }, "brand": { "type": "string", "title": "Brand", "description": "Brand or franchise name." }, "text": { "type": "string", "title": "Text", "description": "Plain-text snapshot to parse without live fetching." }, "html": { "type": "string", "title": "HTML", "description": "HTML snapshot to parse without live fetching." }, "records": { "type": "array", "items": { "type": "object", "additionalProperties": false, "properties": { "brand": { "type": "string", "title": "Brand", "description": "Brand or franchise name." }, "locationName": { "type": "string", "title": "Location name", "description": "Location display name." }, "name": { "type": "string", "title": "Name", "description": "Name for this item." }, "city": { "type": "string", "title": "City", "description": "City for this location." }, "state": { "type": "string", "title": "State", "description": "State, province, or region for this location." }, "pageUrl": { "type": "string", "title": "Page URL", "description": "Public page URL for this record." }, "url": { "type": "string", "title": "URL", "description": "Public URL for this item." }, "pageType": { "type": "string", "title": "Page type", "description": "Type of page represented by this record." } } }, "title": "Records", "description": "Structured source records to inspect." } } } }, "urls": { "title": "Public URLs", "maxItems": 50, "type": "array", "description": "Public URLs to fetch when URL fetching is enabled.", "items": { "type": "string" } }, "fetchUrls": { "title": "Fetch URLs", "type": "boolean", "description": "Fetch public URLs when inline content is not supplied.", "default": false }, "fetchTimeoutMs": { "title": "Fetch timeout", "minimum": 1000, "maximum": 30000, "type": "integer", "description": "Maximum time to wait when fetching a public URL.", "default": 10000 }, "maxTargets": { "title": "Max targets", "minimum": 1, "maximum": 50, "type": "integer", "description": "Maximum number of targets to process.", "default": 2 }, "maxTextBytes": { "title": "Max text bytes", "minimum": 1000, "maximum": 1000000, "type": "integer", "description": "Maximum bytes of text, HTML, or XML to read per source.", "default": 120000 }, "includeReport": { "title": "Create report", "type": "boolean", "description": "Write summary report artifacts.", "default": true }, "dryRun": { "title": "Dry run", "type": "boolean", "description": "Validate input and report diagnostics without paid output rows.", "default": false }, "debug": { "title": "Debug logging", "type": "boolean", "description": "Enable additional diagnostic logging.", "default": false } } }, "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 } } } } } } } } }}OpenAPI is a standard for designing and describing RESTful APIs, allowing developers to define API structure, endpoints, and data formats in a machine-readable way. It simplifies API development, integration, and documentation.
OpenAPI is effective when used with AI agents and GPTs by standardizing how these systems interact with various APIs, for reliable integrations and efficient communication.
By defining machine-readable API specifications, OpenAPI allows AI models like GPTs to understand and use varied data sources, improving accuracy. This accelerates development, reduces errors, and provides context-aware responses, making OpenAPI a core component for AI applications.
You can download the OpenAPI definitions for Franchise Page Inventory from the options below:
If you’d like to learn more about how OpenAPI powers GPTs, read our blog post.
You can also check out our other API clients: