Skip to main content

Add project

Adds and updates a new URL

Request​

GET or POST https://api.wattspeed.com/v1/add

Headers
Authorization  string required

Your API token.

Parameters
url  string required

The URL that you want to add

device  string required

Allowed values: mobile, desktop.

location  array of strings required

When passing multiple locations, include each location in a different parameter using the same name. Example: location=s_carolina&location=tokyo.
Allowed values: s_carolina, los_angeles, frankfurt, london, tokyo, sao_paulo.

frequency  string required

Allowed values: manual, daily, weekly, monthly.

updateDay  number 

Used only for weekly and monthly frequencies.

For weekly, the day index, where 1 is Monday, and 7 is Sunday.

For monthly, the number of your desired day.

name  string 

The name of your project

get_crux  boolean 

Gather or not the CrUX data. Allowed values: true, false.

followRedirects  boolean 

Useful if the first request to the url returns a redirect status code. Allowed values: true, false.

Example request​

GET​

https://api.wattspeed.com/v1/add?name=wattspeed.com.com&url=https://wattspeed.com&device=mobile&locations=london&frequency=daily&get_crux=true&followRedirects=true

POST​

{
  "name": "wattspeed.com",
  "url": "https://wattspeed.com",
  "device": "mobile",
  "locations": ["london"],
  "frequency": "daily",
  "get_crux": false,
  "followRedirects": false
}

Responses​

{
  "addedDomains": [
    "https://wattspeed.com"
  ]
}