Site Group

Resources

URI

Environment	URI
Production	`https://api.freewheel.tv/services/v4/site_groups/[FW_ID]?[parameter1]=[query1]&...`

Attributes

Name	Type	Description	Creatable?	Updatable?	Showable?	Validation
id	FW_ID	ID of the Site Group in FreeWheel	No	No	Yes
name	String	The ame of the Site Group	Req	Yes	Yes	Must be unique on the network and should be at least 3 characters long
tag	String	A unique tag of the site group.	Req	Yes	Yes	Must be unique on the network and should be at least 3 characters long
description	String	Description of the Site Group	Yes	Yes	Yes
customized_metadata	String	Site group customized metadata	Yes	Yes
metadata	Custom Data Type 2	Site Group metadata	Yes	Yes	Yes
status	['ACTIVE', 'INACTIVE']	Site Group status.	No	Yes	Yes	Must be provided in ALL CAPITAL letters.
external_id	String	The Site Group's External ID	Yes	Yes	Yes
session_duration	Integer	The duration after which a user’s session data expires (in seconds). See the MRM User Guide for more details.	No	Yes	Yes	Must be greater than or equal to 300
updated_at	DateTime	Last updated time.	No	No	Yes
created_at	DateTime	Created time	No	No	Yes

Custom Data Type 2: customized_metadata

Name	Type	Description	Creatable?	Updatable?	Showable?	Validations
key	String		Yes	Yes	Yes	Unique
value	String		Yes	Yes	Yes

JSON Sample

{
      "customized_metadata":{
          "key1":"value1",
          "key2":"value2"
      }
  }

XML Sample

<site_group>
  ...
    <customized_metadata>
        <key_value>
            <key>key1</key>
            <value>value1</value>
        </key_value>
        <key_value>
            <key>key2</key>
            <value>value2</value>
        </key_value>
    </customized_metadata>
  </site_group>