Vendasta Website Pro Monitor API

{
  "components": {
    "schemas": {
      "protobufAny": {
        "additionalProperties": {},
        "properties": {
          "@type": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "rpcStatus": {
        "properties": {
          "code": {
            "format": "int32",
            "type": "integer"
          },
          "details": {
            "items": {
              "$ref": "#/components/schemas/protobufAny"
            },
            "type": "array"
          },
          "message": {
            "type": "string"
          }
        },
        "type": "object"
      },
      "v1FetchUptimeDataRequest": {
        "description": "Request to fetch uptime data for a specific account within a date range.",
        "properties": {
          "accountId": {
            "description": "Required. The account ID to fetch uptime data for.",
            "type": "string"
          },
          "end": {
            "description": "Optional. The end of the date range for uptime data.",
            "format": "date-time",
            "type": "string"
          },
          "start": {
            "description": "Optional. The start of the date range for uptime data.",
            "format": "date-time",
            "type": "string"
          }
        },
        "required": [
          "accountId"
        ],
        "title": "FetchUptimeDataRequest",
        "type": "object"
      },
      "v1FetchUptimeDataResponse": {
        "description": "Response containing uptime events and uptime percentages for the requested period.",
        "properties": {
          "currentUptime": {
            "description": "Output only. The current uptime percentage for the requested period.",
            "format": "int32",
            "readOnly": true,
            "type": "integer"
          },
          "events": {
            "description": "Output only. The list of uptime events within the requested date range.",
            "items": {
              "$ref": "#/components/schemas/v1UptimeEvent"
            },
            "readOnly": true,
            "type": "array"
          },
          "previousUptime": {
            "description": "Output only. The previous uptime percentage for comparison.",
            "format": "int32",
            "readOnly": true,
            "type": "integer"
          }
        },
        "title": "FetchUptimeDataResponse",
        "type": "object"
      },
      "v1SiteHealths": {
        "description": "Health and uptime status information for a WordPress site.",
        "properties": {
          "accountGroupName": {
            "description": "Output only. The account group name associated with this site.",
            "readOnly": true,
            "type": "string"
          },
          "accountId": {
            "description": "Output only. The account ID associated with this site.",
            "readOnly": true,
            "type": "string"
          },
          "activationStatus": {
            "description": "Output only. The activation status of the site.",
            "readOnly": true,
            "type": "string"
          },
          "currentHealth": {
            "description": "Output only. The current health status of the site.",
            "readOnly": true,
            "type": "string"
          },
          "partnerId": {
            "description": "Output only. The partner ID that owns this site.",
            "readOnly": true,
            "type": "string"
          },
          "siteId": {
            "description": "Output only. The unique identifier of the site.",
            "readOnly": true,
            "type": "string"
          },
          "statusCode": {
            "description": "Output only. The HTTP status code from the latest health check.",
            "readOnly": true,
            "type": "string"
          },
          "uptime1day": {
            "description": "Output only. The uptime percentage over the last 1 day.",
            "readOnly": true,
            "type": "string"
          },
          "uptime30days": {
            "description": "Output only. The uptime percentage over the last 30 days.",
            "readOnly": true,
            "type": "string"
          },
          "uptime7days": {
            "description": "Output only. The uptime percentage over the last 7 days.",
            "readOnly": true,
            "type": "string"
          }
        },
        "title": "SiteHealths",
        "type": "object"
      },
      "v1UptimeEvent": {
        "description": "A single uptime event data point with timestamp and value.",
        "properties": {
          "dateTime": {
            "description": "Output only. The date and time of the uptime event.",
            "format": "date-time",
            "readOnly": true,
            "type": "string"
          },
          "value": {
            "description": "Output only. The uptime value at this point in time.",
            "readOnly": true,
            "type": "string"
          }
        },
        "title": "UptimeEvent",
        "type": "object"
      },
      "v1UptimeSearchRequest": {
        "description": "Request to search for WordPress site uptime data for a partner.",
        "properties": {
          "partnerId": {
            "description": "Required. The partner ID to search uptime data for.",
            "type": "string"
          }
        },
        "required": [
          "partnerId"
        ],
        "title": "UptimeSearchRequest",
        "type": "object"
      },
      "v1UptimeSearchResponse": {
        "description": "Response containing uptime and health data for WordPress sites.",
        "properties": {
          "siteHealths": {
            "description": "Output only. The list of site health records.",
            "items": {
              "$ref": "#/components/schemas/v1SiteHealths"
            },
            "readOnly": true,
            "type": "array"
          },
          "totalResults": {
            "description": "Output only. The total number of results for this query across all pages.",
            "format": "int64",
            "readOnly": true,
            "type": "string"
          }
        },
        "title": "UptimeSearchResponse",
        "type": "object"
      }
    },
    "securitySchemes": {
      "OAuth2": {
        "flows": {
          "authorizationCode": {
            "authorizationUrl": "https://sso-api-prod.apigateway.co/oauth2/auth",
            "scopes": {
              "business-app": "Allows the application to manage all features of Business App"
            },
            "tokenUrl": "https://sso-api-prod.apigateway.co/oauth2/token"
          }
        },
        "type": "oauth2"
      }
    }
  },
  "info": {
    "title": "WSP Monitor",
    "version": "1.2.1"
  },
  "openapi": "3.0.0",
  "paths": {
    "/v1/wph/monitor/search": {
      "post": {
        "operationId": "Monitor_Search",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/v1UptimeSearchRequest"
              }
            }
          },
          "description": "Request to search for WordPress site uptime data for a partner.",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1UptimeSearchResponse"
                }
              }
            },
            "description": "A successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/rpcStatus"
                }
              }
            },
            "description": "An unexpected error response."
          }
        },
        "summary": "Search Monitors",
        "tags": [
          "Monitor"
        ]
      }
    },
    "/v1/wph/monitor/uptime": {
      "post": {
        "operationId": "Monitor_FetchUptimeData",
        "requestBody": {
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/v1FetchUptimeDataRequest"
              }
            }
          },
          "description": "Request to fetch uptime data for a specific account within a date range.",
          "required": true
        },
        "responses": {
          "200": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/v1FetchUptimeDataResponse"
                }
              }
            },
            "description": "A successful response."
          },
          "default": {
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/rpcStatus"
                }
              }
            },
            "description": "An unexpected error response."
          }
        },
        "security": [
          {
            "OAuth2": [
              "business-app"
            ]
          }
        ],
        "summary": "Fetch Uptime Data",
        "tags": [
          "Monitor"
        ]
      }
    }
  },
  "servers": [
    {
      "description": "Production",
      "url": "https://prod.apigateway.co/grpc"
    }
  ],
  "tags": [
    {
      "name": "Monitor"
    }
  ]
}