Introduction

This API includes the methods to create/retrieve/update and some other operations on Sites, Site Groups and Site Sections.

Resources

• Site
• Site Group
• Site Section

Data Structures

SelfSiteHref

• rel: self -Self site
• href: /services/v4/sites/654936 -Self href

ParentSiteGroupsHref

• rel: parent_site_groups -Parent site group
• href: /services/v4/sites/654936/parent_site_groups -Parent site group href

ChildSiteSectionsHref

• rel: child_site_sections -Child site section
• href: /services/v4/sites/654936/child_site_sections -Child site section href

SiteDataInList

• id: 654936 (number) - Unique identifier
• name: blip.tv (required) - Name of the site. (Uniqueness required)
• status: ACTIVE, INACTIVE(enum) -Status of the site
• tag: tag(required) - A Unique tag of the site
• metadata: metadata -Metadata of the site
• description: Some Description - Description of the site
• rating: G, PG, PG-13, R, Mature, Unrated(enum) -Rating of the site,(G, PG, PG-13, R, Mature, Unrated(Default))
• external_id: Clients' External ID -External ID
• updated_at: 2010-01-18T12:00:00Z -Last updated time
• created_at: 2010-01-18T12:00:00Z -Created time
• url: http://www.blip.tv -URL of the site
• session_duration: 300 (number) -User session duration in seconds(>= 300)
• links: (array[SelfSiteHref, ParentSiteGroupsHref, ChildSiteSectionsHref])

SiteData

• id: 654936 (number) - Unique identifier
• name: blip.tv (required) - Name of the site. (Uniqueness required)
• status: ACTIVE, INACTIVE(enum) -Status of the site
• tag: tag(required) - A Unique tag of the site
• metadata: metadata -Metadata of the site
• content_partner_ids: 97755,96749 (array[number]) - Content partner ids of the site
• description: Some Description - Description of the site
• rating: G, PG, PG-13, R, Mature, Unrated(enum) -Rating of the site,(G, PG, PG-13, R, Mature, Unrated(Default))
• external_id: Clients' External ID -External ID
• updated_at: 2010-01-18T12:00:00Z -Last updated time
• created_at: 2010-01-18T12:00:00Z -Created time
• url: http://www.blip.tv -URL of the site
• session_duration: 300 (number) -User session duration in seconds(>= 300)
• links: (array[SelfSiteHref, ParentSiteGroupsHref, ChildSiteSectionsHref])

SelfPageHref

• rel: self -Self page
• href: /services/v4/sites?page=1&per_page=10 -Current page href

NextPageHref

• rel: next -Next page
• href: /services/v4/sites?page=2&per_page=10 -Next page href

LastPageHref

• rel: last -Last page
• href: /services/v4/sites?page=39&per_page=10 -Last page href

SiteList

• page: 1 (number) -Page number
• per_page: 10 (number) -Per page count
• total_page: 39 (number) -Total page
• total_count: 389 (number) -Total count
• links :(array[SelfPageHref, NextPageHref, LastPageHref])
• items : (array[SiteDataInList])

ParentSiteGroupSelfPageHref

• rel: self -Self page
• href: /services/v4/sites/654906/parent_site_groups?page=1&per_page=10 -Current page href

ParentSiteGroupNextPageHref

• rel: next -Next page
• href: /services/v4/sites/654906/parent_site_groups?page=2&per_page=10 -Next page href

ParentSiteGroupLastPageHref

• rel: last -Last page
• href: /services/v4/sites/654906/parent_site_groups?page=116&per_page=10 -Last page href

ParentSiteGroupList

• page: 1 (number) -Page number
• per_page: 10 (number) -Per page count
• total_page: 39 (number) -Total page
• total_count: 389 (number) -Total count
• links :(array[ParentSiteGroupSelfPageHref, ParentSiteGroupNextPageHref, ParentSiteGroupLastPageHref])
• items : (array[SiteDataInList])

ChildSiteSectionSelfPageHref

• rel: self -Self page
• href: /services/v4/sites/654906/child_site_sections?page=1&per_page=10 -Current page href

ChildSiteSectionNextPageHref

• rel: next -Next page
• href: /services/v4/sites/654906/child_site_sections?page=2&per_page=10 -Next page href

ChildSiteSectionLastPageHref

• rel: last -Last page
• href: /services/v4/sites/654906/child_site_sections?page=116&per_page=10 -Last page href

ChildSiteSectionList

• page: 1 (number) -Page number
• per_page: 10 (number) -Per page count
• total_page: 39 (number) -Total page
• total_count: 389 (number) -Total count
• links :(array[ChildSiteSectionSelfPageHref, ChildSiteSectionNextPageHref, ChildSiteSectionLastPageHref])
• items : (array[SiteDataInList])

SGSelfSiteHref

• rel: self -Self site
• href: /services/v4/site_groups/654949 -Self href

SGParentSiteGroupsHref

• rel: parent_site_groups -Parent site groups
• href: /services/v4/site_groups/654949/parent_site_groups -Parent site groups href

SGChildSiteGroupsHref

• rel: child_site_groups -Child site groups
• href: /services/v4/site_groups/654949/child_site_groups -Child site groups href

SGChildSitesHref

• rel: child_sites -Child sites
• href: /services/v4/site_groups/654949/child_sites -Child sites href

SGChildSiteSectionsHref

• rel: child_site_sections -Child site section
• href: /services/v4/site_groups/654949/child_site_sections -Child site section href

SiteGroupData

• id: 654949 (number) - Unique identifier
• name: blip.tv site group (required) - Name of the site. (Uniqueness required)
• status: ACTIVE, INACTIVE(enum) -Status of the site
• tag: tag(required) - A Unique tag of the site
• metadata: metadata -Metadata of the site
• description: Some Description - Description of the site
• rating: G, PG, PG-13, R, Mature, Unrated(enum) -Rating of the site,(G, PG, PG-13, R, Mature, Unrated(Default))
• external_id: Clients' External ID -External ID
• updated_at: 2010-01-18T12:00:00Z -Last updated time
• created_at: 2010-01-18T12:00:00Z -Created time
• url: http://www.blip.tv -URL of the site
• session_duration: 300 -User session duration in seconds(>= 300)
• links: (array[SGSelfSiteHref, SGParentSiteGroupsHref, SGChildSiteGroupsHref, SGChildSitesHref, SGChildSiteSectionsHref])

SGSelfPageHref

• rel: self -Self page
• href: /services/v4/site_groups?page=1&per_page=10 -Current page href

SGNextPageHref

• rel: next -Next page
• href: /services/v4/site_groups?page=2&per_page=10 -Next page href

SGLastPageHref

• rel: last -Last page
• href: /services/v4/site_groups?page=39&per_page=10 -Last page href

SiteGroupList

• page: 1 (number) -Page number
• per_page: 10 (number) -Per page count
• total_page: 39 (number) -Total page
• total_count: 389 (number) -Total count
• links :(array[SGSelfPageHref, SGNextPageHref, SGLastPageHref])
• items : (array[SiteGroupData])

SGParentSiteGroupSelfPageHref

• rel: self -Self page
• href: /services/v4/site_groups/654949/parent_site_groups?page=1&per_page=10 -Current page href

SGParentSiteGroupNextPageHref

• rel: next -Next page
• href: /services/v4/site_groups/654949/parent_site_groups?page=2&per_page=10 -Next page href

SGParentSiteGroupLastPageHref

• rel: last -Last page
• href: /services/v4/site_groups/654949/parent_site_groups?page=116&per_page=10 -Last page href

SGParentSiteGroupList

• page: 1 (number) -Page number
• per_page: 10 (number) -Per page count
• total_page: 39 (number) -Total page
• total_count: 389 (number) -Total count
• links :(array[SGParentSiteGroupSelfPageHref, SGParentSiteGroupNextPageHref, SGParentSiteGroupLastPageHref])
• items : (array[SiteGroupData])

SGChildSiteGroupSelfPageHref

• rel: self -Self page
• href: /services/v4/site_groups/654949/child_site_groups?page=1&per_page=10 -Current page href

SGChildSiteGroupNextPageHref

• rel: next -Next page
• href: /services/v4/site_groups/654949/child_site_groups?page=2&per_page=10 -Next page href

SGPChildSiteGroupLastPageHref

• rel: last -Last page
• href: /services/v4/site_groups/654949/child_site_groups?page=116&per_page=10 -Last page href

SGChildSiteGroupList

• page: 1 (number) -Page number
• per_page: 10 (number) -Per page count
• total_page: 39 (number) -Total page
• total_count: 389 (number) -Total count
• links :(array[SGChildSiteGroupSelfPageHref, SGChildSiteGroupNextPageHref, SGPChildSiteGroupLastPageHref])
• items : (array[SiteGroupData])

SGChildSiteSelfPageHref

• rel: self -Self page
• href: /services/v4/site_groups/654949/child_sites?page=1&per_page=10 -Current page href

SGChildSiteNextPageHref

• rel: next -Next page
• href: /services/v4/site_groups/654949/child_sites?page=2&per_page=10 -Next page href

SGPChildSiteLastPageHref

• rel: last -Last page
• href: /services/v4/site_groups/654949/child_sites?page=116&per_page=10 -Last page href

SGChildSiteList

• page: 1 (number) -Page number
• per_page: 10 (number) -Per page count
• total_page: 39 (number) -Total page
• total_count: 389 (number) -Total count
• links :(array[SGChildSiteSelfPageHref, SGChildSiteNextPageHref, SGPChildSiteLastPageHref])
• items : (array[SiteGroupData])

SGChildSiteSectionSelfPageHref

• rel: self -Self page
• href: /services/v4/site_groups/654949/child_site_sections?page=1&per_page=10 -Current page href

SGChildSiteSectionNextPageHref

• rel: next -Next page
• href: /services/v4/site_groups/654949/child_site_sections?page=2&per_page=10 -Next page href

SGPChildSiteSectionLastPageHref

• rel: last -Last page
• href: /services/v4/site_groups/654949/child_site_sections?page=116&per_page=10 -Last page href

SGChildSiteSectionList

• page: 1 (number) -Page number
• per_page: 10 (number) -Per page count
• total_page: 39 (number) -Total page
• total_count: 389 (number) -Total count
• links :(array[SGChildSiteSectionSelfPageHref, SGChildSiteSectionNextPageHref, SGPChildSiteSectionLastPageHref])
• items : (array[SiteGroupData])

SSSelfSiteHref

• rel: self -Self site
• href: /services/v4/site_sections/1859521 -Self href

SSParentSiteGroupsHref

• rel: parent_site_groups -Parent site groups
• href: /services/v4/site_sections/1859521/parent_site_groups -Parent site groups href

SSParentSitesHref

• rel: parent_sites -Child sites
• href: /services/v4/site_sections/1859521/parent_sites -Parent sites href

SiteSectionDataInList

• id: 1859521 (number) - Unique identifier
• name: blip.tv site section (required) - Name of the site. (Uniqueness required)
• status: ACTIVE, INACTIVE(enum) -Status of the site
• tag: tag(required) - A Unique tag of the site
• metadata: metadata -Metadata of the site
• description: Some Description - Description of the site
• rating: G, PG, PG-13, R, Mature, Unrated(enum) -Rating of the site,(G, PG, PG-13, R, Mature, Unrated(Default))
• external_id: Clients' External ID -External ID
• updated_at: 2010-01-18T12:00:00Z -Last updated time
• created_at: 2010-01-18T12:00:00Z -Created time
• links: (array[SSSelfSiteHref, SSParentSiteGroupsHref, SSParentSitesHref])

SiteSectionData

• id: 1859521 (number) - Unique identifier
• name: blip.tv site section (required) - Name of the site. (Uniqueness required)
• status: ACTIVE, INACTIVE(enum) -Status of the site
• tag: tag(required) - A Unique tag of the site
• metadata: metadata -Metadata of the site
• content_partner_ids: 97755,96749 (array[number]) - Content partner IDs of the site
• description: Some Description - Description of the site
• rating: G, PG, PG-13, R, Mature, Unrated(enum) -Rating of the site,(G, PG, PG-13, R, Mature, Unrated(Default))
• site_id: 1111 (number) - Unique identifier
• external_id: Clients' External ID -External ID
• updated_at: 2010-01-18T12:00:00Z -Last updated time
• created_at: 2010-01-18T12:00:00Z -Created time
• links: (array[SSSelfSiteHref, SSParentSiteGroupsHref])

SSSelfPageHref

• rel: self -Self page
• href: /services/v4/site_sections?page=1&per_page=10 -Current page href

SSNextPageHref

• rel: next -Next page
• href: /services/v4/site_sections?page=2&per_page=10 -Next page href

SSLastPageHref

• rel: last -Last page
• href: /services/v4/site_sections?page=39&per_page=10 -Last page href

SiteSectionList

• page: 1 (number) -Page number
• per_page: 10 (number) -Per page count
• total_page: 39 (number) -Total page
• total_count: 389 (number) -Total count
• links :(array[SSSelfPageHref, SSNextPageHref, SSLastPageHref])
• items : (array[SiteSectionDataInList])

SSParentSiteGroupSelfPageHref

• rel: self -Self page
• href: /services/v4/site_sections/1859521/parent_site_groups?page=1&per_page=10 -Current page href

SSParentSiteGroupNextPageHref

• rel: next -Next page
• href: /services/v4/site_sections/1859521/parent_site_groups?page=2&per_page=10 -Next page href

SSParentSiteGroupLastPageHref

• rel: last -Last page
• href: /services/v4/site_sections/1859521/parent_site_groups?page=39&per_page=10 -Last page href

SSParentSiteGroupList

• page: 1 (number) -Page number
• per_page: 10 (number) -Per page count
• total_page: 39 (number) -Total page
• total_count: 389 (number) -Total count
• links :(array[SSParentSiteGroupSelfPageHref, SSParentSiteGroupNextPageHref, SSParentSiteGroupLastPageHref])
• items : (array[SiteSectionDataInList])

SSParentSiteSelfPageHref

• rel: self -Self page
• href: /services/v4/site_sections/1859521/parent_sites?page=1&per_page=10 -Current page href

SSParentSiteNextPageHref

• rel: next -Next page
• href: /services/v4/site_sections/1859521/parent_sites?page=2&per_page=10 -Next page href

SSParentSiteLastPageHref

• rel: last -Last page
• href: /services/v4/site_sections/1859521/parent_sites?page=39&per_page=10 -Last page href

SSParentSiteList

• page: 1 (number) -Page number
• per_page: 10 (number) -Per page count
• total_page: 39 (number) -Total page
• total_count: 389 (number) -Total count
• links :(array[SSParentSiteSelfPageHref, SSParentSiteNextPageHref, SSParentSiteLastPageHref])
• items : (array[SiteSectionDataInList])

Site

General Resource URL

Production Instance: https://api.freewheel.tv/services/v4/sites/[FW_ID]?[parameter1]=[query1]&...

Attributes

Custom Data Type 1: customized_metadata

JSON Sample

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

XML Sample

<site>
  ...
    <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>