Brand resources - HearstCorp/rover-wiki GitHub Wiki

Brands

https://{domain}/v2/brands

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
created_at	Date	Creation timestamp	no
updated_at	Date	Last update timestamp	no
name	String	Brand name	yes
metadata	Object	Metadata is a JSON object	no
business_unit	Object	Business Unit object	yes
sites	Array	Array of Sites that are members of this brand	no

Business Units

https://{domain}/v2/business-units

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
created_at	Date	Creation timestamp	no
updated_at	Date	Last update timestamp	no
name	String	Business Unit Name	yes
metadata	Object	Metadata is a JSON object	no

Locales

https://{domain}/v2/locales

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
created_at	Date	Creation timestamp	no
updated_at	Date	Last update timestamp	no
name	String	Locale name	yes
language	String	ISO-639 Language Code	yes
country	String	ISO-3166 Country Code	yes
url_path	String	Path for url	yes

Pool Types

https://{domain}/v2/pool-types

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
created_at	Date	Creation timestamp	no
updated_at	Date	Last update timestamp	no
name	String	Pool Type name	yes

Pools

https://{domain}/v2/pools

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
created_at	Date	Creation timestamp	no
updated_at	Date	Last update timestamp	no
name	String	Pool name	yes
type	Object	Pool Type object	yes
sites	Array	Array of Sites that are part
of this pool	no
metadata	Object	Metadata is a JSON object	no

Sites

Note: This endpoint cannot be POST'ed to without changing a feature flag in your environment settings file.

https://{domain}/v2/sites

Properties

Name	Type	Description	Sortable
id	UUID4	Unique resource identifier	yes
created_at	Date	Creation timestamp	yes
updated_at	Date	Last update timestamp	yes
metadata	Object	Metadata is a JSON object	no
brand	Object	Brand object	yes
locale	Object	Locale object	yes
site_prefix	String	Human-readable name identifier for site	yes
domain	String	Site domain	no
image_sitename	String	Sitename image full URL	no
ad_tag	String	URL with parameters/values	no
ad_type	Integer	Tag type (1 - VAST, 2 - IMA)	no

Site Pools

https://{domain}/v2/sites/{id}/pools

Has the same properties as Pool on GET methods. The pool id as parameter id is accepted for POST and DELETE operations. id is accepted for PUT and PATCH operations. Pool resources are associated with a site via POST.