OBJECT

Site

Site

link GraphQL Schema definition

  • type Site {
  • # Id
  • id: Int!
  • # Title
  • title: String!
  • # Used for internal purposes. Use « computedHost » if you care about possible «
  • # www. » prefix (e.g. « www.host.com »). Use « fullHost » if you care about
  • # protocol prefix too (e.g. « https://www.host.com »).
  • host: String!
  • # Host with « www. » prefix depending on site's configuration
  • computedHost: String
  • # Host with protocol
  • fullHost: String
  • baseHost: String
  • # Company that owns this Site
  • company: Company
  • # List of availables locales
  • locales: [String!]!
  • # Locale by default for site
  • defaultLocale: String @deprecated( reason: "Please use "defaultTranslation" field. This field will be modified soon!" )
  • # Locale by default for site
  • defaultTranslation: String!
  • # Email of contact
  • contactEmail: String
  • # Billing Status of site
  • billingStatus: SiteBillingStatus!
  • # Is site deleted?
  • deleted: Boolean
  • # Type
  • siteType: SiteType!
  • # Is Site indexable?
  • indexable: Boolean
  • # Is Site in Https?
  • https: Boolean
  • # Is Site accessible with www domain ?
  • www: Boolean
  • # BackOffice logo
  • backOfficeLogo: Media
  • # Platform Login Form logo
  • platformLoginFormLogo: Media
  • # Logo
  • logo: Media
  • # Favicon
  • favicon: Media
  • # Date of creation
  • createdAt: DateTime
  • # Date of last update
  • updatedAt: DateTime
  • # Site's import reference
  • importRef: String
  • # Is Site enabled?
  • enabled: Boolean!
  • # Phone number
  • phone: String
  • # Call center number (for platform only)
  • callCenterNumber: PhoneNumber
  • # Articles that belong to the Site
  • #
  • # Arguments
  • # title: If specified, filter articles by title (case
  • # insensitive)
  • articles(title: String): [Article]
  • # An Article that belongs to the Site
  • #
  • # Arguments
  • # articleId: Id of an Article
  • # searchChild: If "articleId" is for a parent article, the
  • # article child associated to site will be resolved.
  • article(articleId: Int!, searchChild: Boolean): Article
  • # CallTrackings that belong to the Site
  • callTrackings: [CallTracking!]
  • # The CallTracking that belongs to the Site
  • #
  • # Arguments
  • # callTrackingId: Id of a CallTracking (not used anymore, but the
  • # argument still exists to prevent breaking changes)
  • callTracking(callTrackingId: Int): CallTracking
  • # Statistics of CallTrackings (for a Platform)
  • callTrackingsStatistics: AssociativeArray!
  • # Statistics of CallTrackings (for a Site)
  • siteCallTrackingsStatistics: SiteCallTrackingsStatistics
  • # Detailled statistics of CallTrackings
  • callTrackingsDetailedStatistics: AssociativeArray!
  • # List of calls for site with call tracking
  • #
  • # Arguments
  • # limit: Number of calls to display
  • # page: Page
  • # startDate: Start date for data
  • # endDate: End date for data
  • calls(limit: Int, page: Int, startDate: String, endDate: String): [SiteCall!]
  • # Categories that belong to the Site
  • #
  • # Arguments
  • # title: If specified, search categories by title (case
  • # insensitive)
  • categories(title: String): [Category]
  • # Category that belongs to the Site
  • #
  • # Arguments
  • # categoryId: Id of a Category
  • category(categoryId: Int!): Category
  • # ContactForms that belong to the Site
  • contactForms: [ContactForm]!
  • # A ContactForm that belongs to the Site
  • #
  • # Arguments
  • # contactFormId: Id of a ContactForm
  • contactForm(contactFormId: Int!): ContactForm
  • # Contact form submissions
  • #
  • # Arguments
  • # contactFormId: Id of a ContactForm
  • # date: A date (Format YYYY-mm-dd), all submissions for this
  • # exact date
  • # fromDate: A date (Format YYYY-mm-dd), all submissions from this
  • # date
  • contactFormSubmissions(
  • contactFormId: Int!,
  • date: String,
  • fromDate: String
  • ): [ContactFormSubmission]!
  • # Arguments
  • # contactFormId: Id of a ContactForm
  • contactFormSubmissionStatistics(
  • contactFormId: Int!
  • ): AssociativeArray
  • siteContactFormSubmissionsStatistics: SiteContactFormsSubmissionsStatistics!
  • # Fields that belong to the Site
  • #
  • # Arguments
  • # token: If specified, search fields by token (case insensitive)
  • fields(token: String): [Field]!
  • # Field that belongs to the Site
  • #
  • # Arguments
  • # fieldId: Id of the Field
  • field(fieldId: Int!): Field
  • # Locations that belongs to the Site
  • locations: [Location]!
  • # A Location that belongs to the Site
  • #
  • # Arguments
  • # locationId: Id of Location
  • location(locationId: Int!): Location
  • # Paginated list of Media belonging to the current site from a repository, and
  • # optionnaly to a category.
  • #
  • # Arguments
  • # page: [Not documented]
  • # perPage: [Not documented]
  • # repository: Type of the Site
  • # categoryId: Id of a Media category
  • # filenameFilter: Filter Medias by filename. This is case
  • # insensitive.
  • # titleFilter: Filter Medias by title. This is case insensitive.
  • paginatedMedias(
  • page: Int,
  • perPage: Int,
  • repository: SiteType!,
  • categoryId: Int,
  • filenameFilter: String,
  • titleFilter: String
  • ): PaginatableMedias
  • # List of Media belonging to the current site from a repository, and optionnaly to
  • # a category.
  • #
  • # Arguments
  • # repository: Type of the Site
  • # categoryId: Id of a Media category
  • # filenameFilter: Filter Medias by filename. This is case
  • # insensitive.
  • # titleFilter: Filter Medias by title. This is case insensitive.
  • medias(
  • repository: SiteType!,
  • categoryId: Int,
  • filenameFilter: String,
  • titleFilter: String
  • ): [Media]!
  • # A Media that belongs to the Site
  • #
  • # Arguments
  • # mediaId: Id of a Media
  • # filename: Filename of a Media
  • media(mediaId: Int, filename: String): Media
  • # List of Media belonging to the current site for form
  • #
  • # Arguments
  • # mediaIds: List of the Media ids
  • mediasForForm(mediaIds: [Int]!): [Media]
  • # List of Media categories belonging to the current site
  • mediaCategories: [MediaCategory]
  • # Media category belonging to the current site
  • #
  • # Arguments
  • # mediaCategoryId: Id of a Media category
  • mediaCategory(mediaCategoryId: Int!): MediaCategory
  • # Statistics of Visits
  • visitsStatistics: AssociativeArray! @deprecated( reason: "Please use "visitsDetailedStatistics" field if you need stats for each platform's sites. This field will be modified soon!" )
  • # Statistics of Visits
  • visitsDetailedStatistics: AssociativeArray!
  • # Statistics of Visits (for a Site).
  • siteVisitsStatistics: SiteVisitsStatistics
  • # Keywords statistics for the last X months for a Platform and its children.
  • #
  • # Arguments
  • # period: Number of months to retrieve (from now)
  • keywordsStatistics(period: Int): AssociativeArray!
  • # Keywords statistics for a Site.
  • #
  • # Arguments
  • # nbMonths: Number of months to retrieve (from now)
  • siteKeywordsStatistics(nbMonths: Int): SiteKeywordsStatistics!
  • # Image sliders that belong to the Site
  • imageSliders: [ImageSlider]!
  • # ImagineLists that belong to the Site
  • imagines: [ImagineList]!
  • # ImagineList that belongs to the Site
  • #
  • # Arguments
  • # imagineListId: Id of a ImagineList
  • # searchChild: If "imagineListId" is for a parent ImagineList,
  • # the ImagineList child associated to site will be resolved.
  • imagine(imagineListId: Int!, searchChild: Boolean): ImagineList
  • # Theme engine used for Site
  • themeEngine: ThemeEngine!
  • # Theme used for Site
  • theme: Theme
  • # Available themes for Site
  • themes: [Theme]!
  • # Services that belong to the site
  • services: [Service]!
  • # A services that belongs to the site
  • #
  • # Arguments
  • # serviceId: Id of a service
  • service(serviceId: Int!): Service
  • # Categories of services that belong to the site
  • serviceCategories: [ServiceCategory]!
  • # A category of services that belongs to the site
  • #
  • # Arguments
  • # serviceCategoryId: Id of a category of services
  • serviceCategory(serviceCategoryId: Int!): ServiceCategory
  • # List of reviews
  • reviews: [Review]
  • # Parent site (if exists)
  • parent: Site
  • # Platform's children sites
  • children: [Site]
  • # Average eKomi rating
  • ekomiAverageRating: Float
  • # Category that belongs to the Site
  • #
  • # Arguments
  • # teamWorkerId: Id of a TeamWorker
  • teamWorker(teamWorkerId: Int!): TeamWorker
  • # Emails list separate by comma
  • hiddenOptionalRecipients: String
  • # Number of children websites that have HTTPS enabled or not
  • childrenHttpsStatus: HttpsStatusStatistics
  • # ALP Groups belongings to the parent of this Site
  • alpGroups: [AlpGroup]!
  • # List tags available for site
  • platformTags: [Tag!]!
  • # List tags linked with site to filter articles
  • tags: [Tag!]!
  • # Should uploaded medias see their original filename kept?
  • generateWithOriginalFileName: Boolean!
  • keyAccountManager: LightenedUser
  • }