Admin

This page shows the different endpoints available for fetching aggregation data

Add Scrape Profile

This endpoint will add a new scrape profile to the system, which will then periodicially scrape reviews from that source and reference. The 'ref' field is the key identifier and profiles are deduped on this field. Adding the same ref again will not create a second profile, but in the case of an admin account, the profile will be updated with the provided request details.

URL

POST - https://depot-api.feeditback.com/admin/profile/add

Request

{
  "ref": "xxx", // The target reference of the scrape. For reviews from google, this will be the google place id, for all other sources, a url
  "source": "google", // Source of reviews - google/tripadvisor
  "site": {
    "company_uuid": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxxx", // The company uuid that this site belongs to - company uuid is gathered from the companies webhook
    "name": "", // Name of the site
    "address1": "", // Address Line 1 of the site
    "address2": "", // Address Line 2 of the site
    "address3": "", // Address Line 3 of the site
    "town": "", // Town of the site
    "county": "", // County of the site
    "postcode": "", // Postcode of the site
    "country": "", // Country of the site
    "sectors": [] // An array of uuids for sectors that this site is associated with. A max of 5 different sectors can be assigned, the array must include at least one
  },
  "subscribe": true // when set true, as reviews are scraped, they will be sent to the webhook url registered to your account
}

Validation

Field	Required	Type	Additional
ref	✅	string	google place id or valid url
source	✅	enum	google,tripadvisor
site	✅	object	see below table
subscribe	✅	boolean

Site Object

Field	Required	Type	Additional
company_uuid	✅	uuid
name	✅	string	min=5, max=255
address1	✅	string	min=5, max=255
address2	❌	string	min=5, max=255
address3	❌	string	min=5, max=255
town	✅	string	min=5, max=255
county	✅	string	min=5, max=255
country	✅	string	min=5, max=255
postcode	✅	string	min=5, max=255
sectors	✅	string[]	min=1, max=5

Response

{
  "profile_id": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx"
}

TIP

The returned uuid of the created scrape profile. In the event that a duplicate 'ref' was submitted, the original pre existing profile uuid will be returned.