Gets Domains Rank updates change over time. Raw values are returned.
/radar/ranking/timeseries_groups
get
Radar Ranking
radar-get-ranking-domain-timeseries
{
"business": true,
"enterprise": true,
"free": true,
"pro": true
}{
"enum": [
"com.cloudflare.api.user.read"
]
}[
{
"in": "query",
"name": "limit",
"schema": {
"description": "Limit the number of objects in the response.",
"example": 5,
"type": "integer"
}
},
{
"in": "query",
"name": "rankingType",
"schema": {
"default": "POPULAR",
"description": "The ranking type.",
"enum": [
"POPULAR",
"TRENDING_RISE",
"TRENDING_STEADY"
],
"example": "POPULAR",
"type": "string"
}
},
{
"in": "query",
"name": "name",
"schema": {
"description": "Array of names that will be used to name the series in responses.",
"example": "main_series",
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "location",
"schema": {
"description": "Array of locations (alpha-2 country codes).",
"example": "US",
"items": {
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "domains",
"schema": {
"description": "Array of comma separated list of domains names.",
"example": "google.com,facebook.com",
"items": {
"pattern": "^([a-zA-Z0-9]([a-zA-Z0-9-]{0,63}[a-zA-Z0-9-])?\\.)+[a-zA-Z0-9-]{2,63}$",
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "dateRange",
"schema": {
"description": "For example, use `7d` and `7dControl` to compare this week with the previous week. Use this parameter or set specific start and end dates (`dateStart` and `dateEnd` parameters).",
"items": {
"enum": [
"1d",
"2d",
"7d",
"14d",
"28d",
"12w",
"24w",
"52w",
"1dControl",
"2dControl",
"7dControl",
"14dControl",
"28dControl",
"12wControl",
"24wControl"
],
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "dateStart",
"schema": {
"description": "Array of datetimes to filter the start of a series.",
"example": "2023-09-01T11:41:33.782Z",
"items": {
"format": "date-time",
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "dateEnd",
"schema": {
"description": "End of the date range (inclusive).",
"example": "2023-09-01T11:41:33.782Z",
"items": {
"format": "date-time",
"type": "string"
},
"type": "array"
}
},
{
"in": "query",
"name": "format",
"schema": {
"description": "Format results are returned in.",
"enum": [
"JSON",
"CSV"
],
"example": "json",
"type": "string"
}
}
]null{
"200": {
"content": {
"application/json": {
"schema": {
"properties": {
"result": {
"properties": {
"meta": {
"properties": {
"dateRange": {
"items": {
"properties": {
"endTime": {
"description": "Adjusted end of date range.",
"example": "2022-09-17T10:22:57.555Z",
"format": "date-time",
"type": "string"
},
"startTime": {
"description": "Adjusted start of date range.",
"example": "2022-09-16T10:22:57.555Z",
"format": "date-time",
"type": "string"
}
},
"required": [
"startTime",
"endTime"
],
"type": "object"
},
"type": "array"
}
},
"required": [
"dateRange"
],
"type": "object"
},
"serie_0": {
"additionalProperties": {
"items": {
"anyOf": [
{
"type": "string"
},
{
"type": "number"
}
]
},
"type": "array"
},
"example": {
"google.com": [
2
],
"timestamps": [
"2022-09-02"
]
},
"properties": {
"timestamps": {
"items": {
"type": "string"
},
"type": "array"
}
},
"required": [
"timestamps"
],
"type": "object"
}
},
"required": [
"meta",
"serie_0"
],
"type": "object"
},
"success": {
"example": true,
"type": "boolean"
}
},
"required": [
"result",
"success"
],
"type": "object"
}
}
},
"description": "Successful Response"
},
"400": {
"content": {
"application/json": {
"schema": {
"properties": {
"errors": {
"items": {
"properties": {
"message": {
"type": "string"
}
},
"required": [
"message"
],
"type": "object"
},
"type": "array"
},
"result": {
"type": "object"
},
"success": {
"example": false,
"type": "boolean"
}
},
"required": [
"result",
"success",
"errors"
],
"type": "object"
}
}
},
"description": "Bad Request"
}
}[
{
"api_email": [],
"api_key": []
}
]