{
  "openapi": "3.0.1",
  "info": {
    "title": "Campaign UTM Policy Audit",
    "description": "Audit campaign URLs against your UTM policy. Detect missing tags, duplicates, invalid encoding and conflicting campaign names. Export JSON, correction CSV and HTML.",
    "version": "1.0",
    "x-build-id": "HPSPx0MgtJCexSOqG"
  },
  "servers": [
    {
      "url": "https://api.apify.com/v2"
    }
  ],
  "paths": {
    "/acts/h_murdock~campaign-utm-policy-audit/run-sync-get-dataset-items": {
      "post": {
        "operationId": "run-sync-get-dataset-items-h_murdock-campaign-utm-policy-audit",
        "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/h_murdock~campaign-utm-policy-audit/runs": {
      "post": {
        "operationId": "runs-sync-h_murdock-campaign-utm-policy-audit",
        "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/h_murdock~campaign-utm-policy-audit/run-sync": {
      "post": {
        "operationId": "run-sync-h_murdock-campaign-utm-policy-audit",
        "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",
        "required": [
          "policy"
        ],
        "properties": {
          "rows": {
            "title": "Campaign rows",
            "minItems": 1,
            "maxItems": 2000,
            "type": "array",
            "description": "Array of {id,url,campaignId?,channel?}. Duplicate IDs are reported, never merged. Use either rows or csv.",
            "items": {
              "type": "object",
              "properties": {
                "id": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 256,
                  "title": "id",
                  "description": "id configuration. See README for exact semantics."
                },
                "url": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 12000,
                  "title": "url",
                  "description": "url configuration. See README for exact semantics."
                },
                "campaignId": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 256,
                  "title": "campaignId",
                  "description": "campaignId configuration. See README for exact semantics."
                },
                "channel": {
                  "type": "string",
                  "minLength": 1,
                  "maxLength": 256,
                  "title": "channel",
                  "description": "channel configuration. See README for exact semantics."
                }
              },
              "required": [
                "id",
                "url"
              ],
              "additionalProperties": false
            }
          },
          "csv": {
            "title": "CSV text",
            "type": "string",
            "description": "Alternative to rows: UTF-8 CSV with id,url and optional campaignId,channel. Supports BOM and quoted fields. Do not supply rows at the same time."
          },
          "columnMapping": {
            "title": "CSV column mapping",
            "type": "object",
            "description": "Optional field-to-header map for CSV, for example {\"id\":\"Link ID\",\"url\":\"Destination\"}. id/url default to their own names. Unmapped extra CSV columns are ignored.",
            "properties": {
              "id": {
                "type": "string",
                "title": "id",
                "description": "id configuration. See README for exact semantics."
              },
              "url": {
                "type": "string",
                "title": "url",
                "description": "url configuration. See README for exact semantics."
              },
              "campaignId": {
                "type": "string",
                "title": "campaignId",
                "description": "campaignId configuration. See README for exact semantics."
              },
              "channel": {
                "type": "string",
                "title": "channel",
                "description": "channel configuration. See README for exact semantics."
              }
            },
            "additionalProperties": false
          },
          "policy": {
            "title": "Campaign policy",
            "required": [],
            "type": "object",
            "description": "Required parameters, exact allowedValues, source/medium pairs, optional lowercase/uppercase value policy, direct aliases and exact allowedMacros. See README for supported syntax and limits.",
            "properties": {
              "requiredParameters": {
                "type": "array",
                "items": {
                  "type": "string",
                  "pattern": "^[A-Za-z][A-Za-z0-9_]{0,63}$"
                },
                "maxItems": 32,
                "uniqueItems": true,
                "default": [
                  "utm_source",
                  "utm_medium",
                  "utm_campaign"
                ],
                "title": "requiredParameters",
                "description": "requiredParameters configuration. See README for exact semantics.",
                "editor": "json"
              },
              "allowedValues": {
                "type": "object",
                "additionalProperties": true,
                "title": "allowedValues",
                "description": "allowedValues configuration. See README for exact semantics.",
                "editor": "json"
              },
              "allowedSourceMediumPairs": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "source": {
                      "type": "string",
                      "title": "source",
                      "description": "source configuration. See README for exact semantics."
                    },
                    "medium": {
                      "type": "string",
                      "title": "medium",
                      "description": "medium configuration. See README for exact semantics."
                    }
                  },
                  "required": [
                    "source",
                    "medium"
                  ],
                  "additionalProperties": false
                },
                "maxItems": 100,
                "title": "allowedSourceMediumPairs",
                "description": "allowedSourceMediumPairs configuration. See README for exact semantics.",
                "editor": "json"
              },
              "casePolicy": {
                "type": "string",
                "enum": [
                  "none",
                  "lowercase",
                  "uppercase"
                ],
                "default": "none",
                "title": "casePolicy",
                "description": "casePolicy configuration. See README for exact semantics."
              },
              "aliases": {
                "type": "object",
                "additionalProperties": true,
                "title": "aliases",
                "description": "aliases configuration. See README for exact semantics.",
                "editor": "json"
              },
              "allowedMacros": {
                "type": "array",
                "items": {
                  "type": "string"
                },
                "maxItems": 64,
                "title": "allowedMacros",
                "description": "allowedMacros configuration. See README for exact semantics.",
                "editor": "json"
              }
            },
            "additionalProperties": 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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "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
                  },
                  "PROXY_UNBLOCKER_UNITS": {
                    "type": "integer",
                    "example": 0
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}