Body
This is the Audit start body object
-
url string Required
The url of webpage
-
device string Required
Values are
mobile
,desktop
,macbookAir2020
,highEndLaptop
,macbookPro133
,macbookPro16
,msSurfaceBook315
,msSurfaceBook3135
,msSurface
,ipad102
,samsungGalaxyTab7
,iphone13ProMax
,iphone11
,samsungGalaxyS10Plus
,redmiNote8Pro
,iphone7
,samsungGalaxyA50
,motorolaMotoG5
,redmi5A
,iphone13Pro
,iphone8Plus
,ipadPro129
,samsungGalaxyA32
,samsungGalaxyS21Ultra
,samsungGalaxyS20
,oneplus10Pro
,oneplus7
,iphoneXR
,iphone5
,iphone6
,iphone11Pro
,iphone12Pro
,iphone12Mini
,pixel
,oneplusNord
,samsungGalaxyS8
,pixel3
,pixel4
,pixel5
,pixel6
, orpixel6Pro
. -
location string Required
Values are
in
,us-tx
,us-ca
,eu
,fr
,au
,qa
,sk
,uk
,ca
,sa
,br
, orsea
. -
network string Required
Values are
fiber
,cable
,dsl
,normal5g
,wifiFast
,wifi
,normal4gFast
,desktopDense4G
,normal4g
,normal3gSlow
,normal2gEdge
,normal2g
,mobileSlow4g
, ormobileRegular4g
.
curl \
-X POST https://api.auditzy.com/v1/audit/start \
-H "X-ADZ-KEY: $API_KEY" \
-H "Content-Type: application/json" \
-d '{"url":"https://auditzy.com","device":"macbookAir2020","location":"in","network":"normal5g"}'
{
"url": "https://auditzy.com",
"device": "macbookAir2020",
"location": "in",
"network": "normal5g"
}
{
"trackingId": "LGHKJGCEIQzrdCox",
"status": "SUCCESS"
}
{
"message": "Invalid Request body or missing required parameters",
"status": "FAILURE"
}
{
"message": "Insufficient Credits",
"status": "FAILURE"
}
{
"message": "Invalid Url",
"status": "FAILURE"
}