Competitors

Please refer to the Authentication document on how to obtain and use an API key.

Available actions & endpoints

Fetching all competitors

GET /v1/competitors (Fetch all competitors)

URL Parameters

name	type	data type	description
None	N/A	N/A	N/A

Query Parameters

name	required	data type	description
businessUuid	Yes	string	The uuid of the business you would like to fetch the competitors for

Responses

http code	content-type	response
200	application/json	See example response
401	application/json	{"code":401,"message": "Authentication is required to continue"}

Example cURL

 curl -X GET -H "api-key: [YOUR API KEY]" https://api.monitor.insites.com/v1/competitors?competitorUuid=[THE competitorUuid]

Example Response

{
  "data": [
    {
      "uuid": "6726dae5-0091-4efe-9270-aa9d3073a3fd",
      "name": "Silktide",
      "hostname": "https://www.silktide.com/",
      "industry": "Accessibility",
      "address_line_1": "Brunel Parkway",
      "address_line_2": "Pride Park",
      "address_line_3": "",
      "city": "Derby",
      "county": "Derbyshire",
      "country_code": "GB",
      "postcode": "DE24 8HR",
      "created_at": "2022-11-07T12:41:17+00:00",
      "updated_at": "2022-11-07T12:41:17+00:00",
      "business_uuid": "e3f59007-0cf7-461d-9c10-b90c949273a5",
      "phone_number": "+441332460460"
    }
  ],
  "meta": {
    "per_page": 20,
    "from": 1,
    "to": 1,
    "current_page": 1,
    "last_page": 1,
    "total": 1,
    "next_page_url": null,
    "prev_page_url": null,
    "first_page_url": "http://localhost:8000/v1/competitors?page=1",
    "last_page_url": "http://localhost:8000/v1/competitors?page=1"
  }
}

Fetching a specific competitor

GET /v1/competitors/[competitor_uuid] (Fetch competitor)

URL Parameters

name	required	data type	description
competitor_uuid	Yes	string	The uuid of the competitor you would like to fetch

Query Parameters

name	required	data type	description
None	N/A	N/A	N/A

Responses

http code	content-type	response
200	application/json	See example response
404	application/json	{"code":404,"message": "Record not found in table \"competitors\""}
401	application/json	{"code":401,"message": "Authentication is required to continue"}

Example cURL

 curl -X GET https://api.monitor.insites.com/v1/competitor/[competitor_uuid]
      -H "api-key: [YOUR API KEY]"

Example Response

{
  "data": {
    "uuid": "6726dae5-0091-4efe-9270-aa9d3073a3fd",
    "name": "Silktide",
    "hostname": "https://www.silktide.com/",
    "industry": "Accessibility",
    "address_line_1": "Brunel Parkway",
    "address_line_2": "Pride Park",
    "address_line_3": "",
    "city": "Derby",
    "county": "Derbyshire",
    "country_code": "GB",
    "postcode": "DE24 8HR",
    "created_at": "2022-11-07T12:41:17+00:00",
    "updated_at": "2022-11-07T12:41:17+00:00",
    "business_uuid": "e3f59007-0cf7-461d-9c10-b90c949273a5",
    "phone_number": "+441332460460"
  }
}

Creating a competitor

POST /v1/competitors (Create competitor)

URL Parameters

name	required	data type	description
None	N/A	N/A	N/A

Query Parameters

name	required	data type	description
businessUuid	Yes	string	The uuid of the business you would like to create a competitor for

Responses

http code	content-type	response
200	application/json	See example response
422	application/json	{"success":false,"message":"error","errors":{"hostname":{"length":"Hostname name must be < 255 characters"}}}
401	application/json	{"code":401,"message": "Authentication is required to continue"}

Example cURL

 curl -X POST https://api.monitor.insites.com/v1/competitors
      -H "api-key: [YOUR API KEY]"
      -H "Content-Type: application/json"
      -d "[SEE EXAMPLE REQUEST BODY]"

Example Request Body

{
  "hostname": "https://www.insites.com"
}

Example Response

{
  "message": "success",
  "success": true,
  "data": {
    "uuid": "6726dae5-0091-4efe-9270-aa9d3073a3fd",
    "name": "Silktide",
    "hostname": "https://www.silktide.com/",
    "industry": "Accessibility",
    "address_line_1": "Brunel Parkway",
    "address_line_2": "Pride Park",
    "address_line_3": "",
    "city": "Derby",
    "county": "Derbyshire",
    "country_code": "GB",
    "postcode": "DE24 8HR",
    "created_at": "2022-11-07T12:41:17+00:00",
    "updated_at": "2022-11-07T12:41:17+00:00",
    "business_uuid": "e3f59007-0cf7-461d-9c10-b90c949273a5",
    "phone_number": "+441332460460"
  }
}

Updating a competitor

PATCH /v1/competitors/[competitor_uuid] (Update competitor)

URL Parameters

name	required	data type	description
competitor_uuid	Yes	string	The uuid of the competitor you would like to update

Query Parameters

name	required	data type	description
None	N/A	N/A	N/A

Responses

http code	content-type	response
200	application/json	See example response
422	application/json	{"success":false,"message":"error","errors":{"hostname":{"length":"Hostname name must be < 255 characters"}}}
401	application/json	{"code":401,"message": "Authentication is required to continue"}

Example cURL

 curl -X PATCH https://api.monitor.insites.com/v1/competitors/[competitor_uuid]
      -H "api-key: [YOUR API KEY]"
      -H "Content-Type: application/json"
      -d "[SEE EXAMPLE REQUEST BODY]"

Example Request Body

{
  "name": "Silktide Ltd",
  "hostname": "https://www.silktide.com/",
  "industry": "Accessibility",
  "address_line_1": "Brunel Parkway, Pride Park",
  "address_line_2": "",
  "address_line_3": "",
  "city": "Derby",
  "county": "Derbyshire",
  "country_code": "GB",
  "postcode": "DE24 8HR",
  "phone_number": "+441332460460"
}

Example Response

{
  "message": "success",
  "success": true,
  "data": {
    "uuid": "6726dae5-0091-4efe-9270-aa9d3073a3fd",
    "name": "Silktide Ltd",
    "hostname": "https://www.silktide.com/",
    "industry": "Accessibility",
    "address_line_1": "Brunel Parkway, Pride Park",
    "address_line_2": "",
    "address_line_3": "",
    "city": "Derby",
    "county": "Derbyshire",
    "country_code": "GB",
    "postcode": "DE24 8HR",
    "created_at": "2022-11-07T12:41:17+00:00",
    "updated_at": "2022-11-07T12:41:17+00:00",
    "business_uuid": "e3f59007-0cf7-461d-9c10-b90c949273a5",
    "phone_number": "+441332460460"
  }
}

Deleting a competitor

DELETE /v1/competitors/[competitor_uuid] (Delete competitor)

URL Parameters

name	required	data type	description
competitor_uuid	Yes	string	The uuid of the competitor you would like to delete

Query Parameters

name	required	data type	description
None	N/A	N/A	N/A

Responses

http code	content-type	response
200	application/json	{"success":true,"message":"success"}
401	application/json	{"code":401,"message": "Authentication is required to continue"}

Example cURL

 curl -X DELETE https://api.monitor.insites.com/v1/competitors/[competitor_uuid]
      -H "api-key: [YOUR API KEY]"