{
  "service": "similarweb_digitalrank_api",
  "displayName": "Similarweb",
  "categories": [
    "Data",
    "Marketing"
  ],
  "authTypes": [
    "api_key"
  ],
  "auth": [
    {
      "type": "api_key",
      "label": "API Key",
      "placeholder": "SIMILARWEB_API_KEY",
      "description": "Similarweb API key sent with the api_key query parameter. Generate it in Settings > Account > API: https://developers.similarweb.com/docs/get-api-key"
    }
  ],
  "homepageUrl": "https://www.similarweb.com",
  "actions": [
    {
      "id": "similarweb_digitalrank_api.get_rank_tracker_describe",
      "service": "similarweb_digitalrank_api",
      "name": "get_rank_tracker_describe",
      "description": "List Similarweb rank-tracker campaigns and their scraping configurations for follow-up reporting APIs.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false,
        "description": "This action does not require any input fields."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "campaigns": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "campaignId": {
                  "type": "string",
                  "description": "The unique identifier of the rank-tracker campaign."
                },
                "campaignName": {
                  "type": "string",
                  "description": "The campaign display name."
                },
                "mainDomain": {
                  "type": "string",
                  "description": "The primary tracked domain for the campaign."
                },
                "user": {
                  "type": "string",
                  "description": "The campaign creator returned by Similarweb."
                },
                "createdTime": {
                  "type": "string",
                  "description": "The campaign creation timestamp."
                },
                "tags": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "description": "One campaign tag."
                  },
                  "description": "The campaign tags returned by Similarweb."
                },
                "competitors": {
                  "type": "array",
                  "items": {
                    "type": "string",
                    "description": "One competitor domain."
                  },
                  "description": "The campaign competitor domains."
                },
                "scrapingConfigurations": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "id": {
                        "type": "string",
                        "description": "The unique identifier of the scraping configuration."
                      },
                      "device": {
                        "type": "string",
                        "description": "The device type used by the scraping configuration."
                      },
                      "language": {
                        "type": "string",
                        "description": "The language configured for the scraping configuration."
                      },
                      "location": {
                        "type": "string",
                        "description": "The location configured for the scraping configuration."
                      },
                      "searchEngine": {
                        "type": "string",
                        "description": "The search engine configured for the scraping configuration."
                      }
                    },
                    "additionalProperties": false,
                    "required": [
                      "id"
                    ],
                    "description": "A rank-tracker scraping configuration returned by Similarweb."
                  },
                  "description": "The scraping configurations available for the campaign."
                }
              },
              "additionalProperties": false,
              "required": [
                "campaignId",
                "tags",
                "competitors",
                "scrapingConfigurations"
              ],
              "description": "A rank-tracker campaign returned by Similarweb."
            },
            "description": "The rank-tracker campaigns returned by Similarweb."
          }
        },
        "additionalProperties": false,
        "description": "The rank-tracker campaign metadata returned by Similarweb."
      }
    },
    {
      "id": "similarweb_digitalrank_api.get_similar_rank_top_sites",
      "service": "similarweb_digitalrank_api",
      "name": "get_similar_rank_top_sites",
      "description": "List Similarweb top-ranked websites for a country and category, defaulting to the global $All ranking when filters are omitted.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {
          "limit": {
            "type": "integer",
            "minimum": 1,
            "description": "The maximum number of ranked sites to return."
          },
          "offset": {
            "type": "integer",
            "minimum": 0,
            "description": "The zero-based offset into the ranked results."
          },
          "country": {
            "type": "string",
            "minLength": 1,
            "description": "The country code to query. Defaults to world for a worldwide ranking."
          },
          "category": {
            "type": "string",
            "minLength": 1,
            "description": "The Similarweb category path segment. Defaults to $All when omitted."
          },
          "startDate": {
            "type": "string",
            "description": "The start month for the ranking window in YYYY-MM format.",
            "pattern": "^\\d{4}-\\d{2}$"
          },
          "endDate": {
            "type": "string",
            "description": "The end month for the ranking window in YYYY-MM format.",
            "pattern": "^\\d{4}-\\d{2}$"
          },
          "sort": {
            "type": "string",
            "minLength": 1,
            "description": "The field used to sort the ranked results."
          },
          "ascending": {
            "type": "boolean",
            "description": "Whether to sort the ranked results in ascending order."
          },
          "showVerified": {
            "type": "boolean",
            "description": "Whether to include only verified domains in the ranked results."
          },
          "mainDomainOnly": {
            "type": "boolean",
            "description": "Whether to include only main domains in the ranked results."
          }
        },
        "additionalProperties": false,
        "description": "The input payload for retrieving Similarweb top-site rankings."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "topSites": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "rank": {
                  "type": "integer",
                  "description": "The traffic rank position of the website."
                },
                "domain": {
                  "type": "string",
                  "description": "The ranked website domain."
                }
              },
              "additionalProperties": false,
              "description": "A ranked website returned by Similarweb."
            },
            "description": "The ranked top sites returned by Similarweb."
          },
          "meta": {
            "type": "object",
            "properties": {},
            "additionalProperties": true,
            "description": "The response metadata returned by Similarweb."
          }
        },
        "additionalProperties": false,
        "required": [
          "topSites"
        ],
        "description": "The Similarweb top-site ranking response."
      }
    },
    {
      "id": "similarweb_digitalrank_api.get_subscription_status",
      "service": "similarweb_digitalrank_api",
      "name": "get_subscription_status",
      "description": "Get the remaining Similarweb usage allowance for the connected API key.",
      "requiredScopes": [],
      "providerPermissions": [],
      "inputSchema": {
        "type": "object",
        "properties": {},
        "additionalProperties": false,
        "description": "This action does not require any input fields."
      },
      "outputSchema": {
        "type": "object",
        "properties": {
          "allowance": {
            "type": "integer",
            "description": "The total data credits allocated to the API key."
          },
          "userRemaining": {
            "type": "integer",
            "description": "The remaining Similarweb data credits for the API key."
          }
        },
        "additionalProperties": false,
        "description": "The subscription usage returned by Similarweb."
      }
    }
  ]
}