local_seo_visibility_check_results

Creates, updates, deletes, gets or lists a local_seo_visibility_check_results resource.

Overview

Name	local_seo_visibility_check_results
Type	Resource
Id	ovh.hosting_web.local_seo_visibility_check_results

Fields

The following fields are returned by SELECT queries:

list

Struct describing a visibility check result

Name	Datatype	Description
name	string	The location's name used for this listing
listing_id	string	The listing id in the directory database (wire: listingId)
city	string	City of the location
city_status	string	City of the location (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: cityStatus)
country	string	Country of the location
country_status	string	Country of the location (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: countryStatus)
date_created	string (date-time)	The date and time the listing was created in database (wire: dateCreated)
directory_type	string	The directory where this listing appears (wire: directoryType)
email	string	A contact email for the location
email_status	string	A contact email for the location (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: emailStatus)
flow_status	string	The status of the current listing (ALL_INFORMATION_SUBMITTED, DONT_REMOVE, INACTIVE, MANUALLY_DEACTIVATED, NEEDS_REVIEW, NOT_SUPPORTED, NO_ACTION_NEEDED, REMOVAL_NEEDED, REMOVAL_REVIEW_NEEDED, REMOVAL_SUBMITTED, REMOVED, SUBMISSION_NEEDED, WAITING_DIRECTORY_ACTION, WAITING_USER_ACTION) (wire: flowStatus)
listing_url	string	The listing url on the directory website (wire: listingUrl)
name_status	string	The location's name used for this listing (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: nameStatus)
phone	string	The location's contact phone number
phone_status	string	The location's contact phone number (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: phoneStatus)
province	string	Province of the location
province_status	string	Province of the location (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: provinceStatus)
street	string	The location's street address
street_and_no	string	A localized combination of street and streetNo (wire: streetAndNo)
street_and_no_status	string	A localized combination of street and streetNo (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: streetAndNoStatus)
street_no	string	The location's street number (wire: streetNo)
street_no_status	string	The location's street number (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: streetNoStatus)
street_status	string	The location's street address (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: streetStatus)
street_type	string	The street type for Spain (wire: streetType)
street_type_status	string	The street type for Spain (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: streetTypeStatus)
sync_status	string	The sync status of the listing (IN_SYNC, NOT_FOUND, NOT_IN_SYNC, NOT_SUPPORTED, NO_ONLINE_LISTING, TECHNICAL_PROBLEMS) (wire: syncStatus)
website	string	A valid url for the location's website
website_status	string	A valid url for the location's website (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: websiteStatus)
zip	string	Zipcode of the location
zip_status	string	Zipcode of the location (sync status) (MATCH, MISMATCH, MISSING, NOT_APPLICABLE, PRESENT) (wire: zipStatus)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list	select	directory, id, token		Get visibility check results. Returns the listings found for the location in each directory, with the sync status of each field.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
api_host	string	The OVHcloud API host. Selected by OVH_ENDPOINT (ovh-eu, ovh-ca or ovh-us; default ovh-eu). (default: api.eu.ovhcloud.com, x-stackQL-envVarSelector: {"envVar":"OVH_ENDPOINT","default":"ovh-eu","values":{"ovh-eu":"api.eu.ovhcloud.com","ovh-ca":"api.ca.ovhcloud.com","ovh-us":"api.us.ovhcloud.com"}})
directory	string	Get the result only for one directory
id	integer	Id of the check
token	string	Token received when requesting the check

SELECT examples

list

Get visibility check results. Returns the listings found for the location in each directory, with the sync status of each field.

SELECT
name,
listing_id,
city,
city_status,
country,
country_status,
date_created,
directory_type,
email,
email_status,
flow_status,
listing_url,
name_status,
phone,
phone_status,
province,
province_status,
street,
street_and_no,
street_and_no_status,
street_no,
street_no_status,
street_status,
street_type,
street_type_status,
sync_status,
website,
website_status,
zip,
zip_status
FROM ovh.hosting_web.local_seo_visibility_check_results
WHERE directory = '{{ directory }}' -- required
AND id = '{{ id }}' -- required
AND token = '{{ token }}' -- required
;