openapi: 3.1.0
info:
title: Microsoft Graph Admin Admin.admin sites.site.Functions API
description: 'Microsoft Graph API for managing administrative resources in Microsoft Entra ID.
This API enables administrators to manage Microsoft Edge browser settings, Internet Explorer mode configurations,
site lists, shared browser sites, Microsoft 365 Apps installation options, people insights, service announcements,
SharePoint settings, Copilot administration, directory administrative units, and admin consent policies.'
version: 1.0.0
contact:
name: Microsoft Graph API Support
url: https://developer.microsoft.com/graph
servers:
- url: https://graph.microsoft.com/v1.0
description: Microsoft Graph API v1.0 endpoint
tags:
- name: sites.site.Functions
x-ms-docs-toc-type: container
paths:
/sites/{site-id}/getActivitiesByInterval():
description: Provides operations to call the getActivitiesByInterval method.
parameters:
- name: site-id
in: path
description: The unique identifier of site
required: true
schema:
type: string
x-ms-docs-key-type: site
x-ms-docs-grouped-path:
- /sites/{site-id}/lists/{list-id}/items/{listItem-id}/getActivitiesByInterval()
- /sites/{site-id}/lists/{list-id}/items/{listItem-id}/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
- /sites/{site-id}/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
- /sites/{site-id}/getByPath(path='{path}')/getActivitiesByInterval()
- /sites/{site-id}/getByPath(path='{path}')/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
get:
tags:
- sites.site.Functions
summary: Microsoft Graph Invoke function getActivitiesByInterval
operationId: sites.site.getActivitiesByInterval-4c35
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of itemActivityStat
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
? /sites/{site-id}/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
: description: Provides operations to call the getActivitiesByInterval method.
parameters:
- name: site-id
in: path
description: The unique identifier of site
required: true
schema:
type: string
x-ms-docs-key-type: site
- name: startDateTime
in: path
description: 'Usage: startDateTime=''{startDateTime}'''
required: true
schema:
type: string
nullable: true
- name: endDateTime
in: path
description: 'Usage: endDateTime=''{endDateTime}'''
required: true
schema:
type: string
nullable: true
- name: interval
in: path
description: 'Usage: interval=''{interval}'''
required: true
schema:
type: string
nullable: true
x-ms-docs-grouped-path:
- /sites/{site-id}/lists/{list-id}/items/{listItem-id}/getActivitiesByInterval()
- /sites/{site-id}/lists/{list-id}/items/{listItem-id}/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
- /sites/{site-id}/getActivitiesByInterval()
- /sites/{site-id}/getByPath(path='{path}')/getActivitiesByInterval()
- /sites/{site-id}/getByPath(path='{path}')/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
get:
tags:
- sites.site.Functions
summary: Microsoft Graph Invoke function getActivitiesByInterval
operationId: sites.site.getActivitiesByInterval-ad27
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of itemActivityStat
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/sites/{site-id}/getApplicableContentTypesForList(listId='{listId}'):
description: Provides operations to call the getApplicableContentTypesForList method.
parameters:
- name: site-id
in: path
description: The unique identifier of site
required: true
schema:
type: string
x-ms-docs-key-type: site
- name: listId
in: path
description: 'Usage: listId=''{listId}'''
required: true
schema:
type: string
x-ms-docs-grouped-path:
- /sites/{site-id}/getByPath(path='{path}')/getApplicableContentTypesForList(listId='{listId}')
get:
tags:
- sites.site.Functions
summary: Microsoft Graph Invoke function getApplicableContentTypesForList
description: Get site contentTypes that can be added to a list.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/site-getapplicablecontenttypesforlist?view=graph-rest-1.0
operationId: sites.site.getApplicableContentTypesForList
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of contentType
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/sites/{site-id}/getByPath(path='{path}'):
description: Provides operations to call the getByPath method.
parameters:
- name: site-id
in: path
description: The unique identifier of site
required: true
schema:
type: string
x-ms-docs-key-type: site
- name: path
in: path
description: 'Usage: path=''{path}'''
required: true
schema:
type: string
nullable: true
get:
tags:
- sites.site.Functions
summary: Microsoft Graph Invoke function getByPath
operationId: sites.site.getByPath
responses:
2XX:
description: Success
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.site'
- type: object
nullable: true
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
/sites/{site-id}/getByPath(path='{path}')/getActivitiesByInterval():
description: Provides operations to call the getActivitiesByInterval method.
parameters:
- name: site-id
in: path
description: The unique identifier of site
required: true
schema:
type: string
x-ms-docs-key-type: site
- name: path
in: path
description: 'Usage: path=''{path}'''
required: true
schema:
type: string
nullable: true
x-ms-docs-grouped-path:
- /sites/{site-id}/lists/{list-id}/items/{listItem-id}/getActivitiesByInterval()
- /sites/{site-id}/lists/{list-id}/items/{listItem-id}/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
- /sites/{site-id}/getActivitiesByInterval()
- /sites/{site-id}/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
- /sites/{site-id}/getByPath(path='{path}')/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
get:
tags:
- sites.site.Functions
summary: Microsoft Graph Invoke function getActivitiesByInterval
operationId: sites.site.getByPath.getActivitiesByInterval-4c35
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of itemActivityStat
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
? /sites/{site-id}/getByPath(path='{path}')/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
: description: Provides operations to call the getActivitiesByInterval method.
parameters:
- name: site-id
in: path
description: The unique identifier of site
required: true
schema:
type: string
x-ms-docs-key-type: site
- name: path
in: path
description: 'Usage: path=''{path}'''
required: true
schema:
type: string
nullable: true
- name: startDateTime
in: path
description: 'Usage: startDateTime=''{startDateTime}'''
required: true
schema:
type: string
nullable: true
- name: endDateTime
in: path
description: 'Usage: endDateTime=''{endDateTime}'''
required: true
schema:
type: string
nullable: true
- name: interval
in: path
description: 'Usage: interval=''{interval}'''
required: true
schema:
type: string
nullable: true
x-ms-docs-grouped-path:
- /sites/{site-id}/lists/{list-id}/items/{listItem-id}/getActivitiesByInterval()
- /sites/{site-id}/lists/{list-id}/items/{listItem-id}/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
- /sites/{site-id}/getActivitiesByInterval()
- /sites/{site-id}/getActivitiesByInterval(startDateTime='{startDateTime}',endDateTime='{endDateTime}',interval='{interval}')
- /sites/{site-id}/getByPath(path='{path}')/getActivitiesByInterval()
get:
tags:
- sites.site.Functions
summary: Microsoft Graph Invoke function getActivitiesByInterval
operationId: sites.site.getByPath.getActivitiesByInterval-ad27
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of itemActivityStat
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.itemActivityStat'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/sites/{site-id}/getByPath(path='{path}')/getApplicableContentTypesForList(listId='{listId}'):
description: Provides operations to call the getApplicableContentTypesForList method.
parameters:
- name: site-id
in: path
description: The unique identifier of site
required: true
schema:
type: string
x-ms-docs-key-type: site
- name: path
in: path
description: 'Usage: path=''{path}'''
required: true
schema:
type: string
nullable: true
- name: listId
in: path
description: 'Usage: listId=''{listId}'''
required: true
schema:
type: string
x-ms-docs-grouped-path:
- /sites/{site-id}/getApplicableContentTypesForList(listId='{listId}')
get:
tags:
- sites.site.Functions
summary: Microsoft Graph Invoke function getApplicableContentTypesForList
description: Get site contentTypes that can be added to a list.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/site-getapplicablecontenttypesforlist?view=graph-rest-1.0
operationId: sites.site.getByPath.getApplicableContentTypesForList
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of contentType
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.contentType'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/sites/delta():
description: Provides operations to call the delta method.
x-ms-docs-grouped-path:
- /sites/{site-id}/lists/{list-id}/items/delta()
- /sites/{site-id}/lists/{list-id}/items/delta(token='{token}')
get:
tags:
- sites.site.Functions
summary: Microsoft Graph Invoke function delta
description: "Get newly created, updated, or deleted sites without having to perform a full read of the entire sites collection. A delta function call for sites is similar to a GET request, except that by appropriately applying state tokens in one or more of these calls,\r\nyou can query for incremental changes in the sites. It allows you to maintain and synchronize a local store of a user's sites without having to fetch all the sites from the server every time.\r\nThe application calls the API without specifying any parameters.\r\nThe service begins enumerating sites and returns pages of changes to these sites, accompanied by either an @odata.nextLink or an @odata.deltaLink.\r\nYour application should continue making calls using the @odata.nextLink until there's an @odata.deltaLink in the response. After you receive all the changes, you can apply them to your local state.\r\nTo monitor future changes, call the delta API by using the @odata.deltaLink in the previous response. Any resources marked as deleted should be removed from your local state."
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/site-delta?view=graph-rest-1.0
operationId: sites.delta
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of site
type: object
allOf:
- $ref: '#/components/schemas/BaseDeltaFunctionResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
/sites/getAllSites():
description: Provides operations to call the getAllSites method.
get:
tags:
- sites.site.Functions
summary: Microsoft Graph Invoke function getAllSites
description: List sites across geographies in an organization. This API can also be used to enumerate all sites in a non-multi-geo tenant. For more information, see Best practices for discovering files and detecting changes at scale.
externalDocs:
description: Find more info here
url: https://learn.microsoft.com/graph/api/site-getallsites?view=graph-rest-1.0
operationId: sites.getAllSites
parameters:
- $ref: '#/components/parameters/top'
- $ref: '#/components/parameters/skip'
- $ref: '#/components/parameters/search'
- $ref: '#/components/parameters/filter'
- $ref: '#/components/parameters/count'
- name: $select
in: query
description: Select properties to be returned
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $orderby
in: query
description: Order items by property values
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
- name: $expand
in: query
description: Expand related entities
style: form
explode: false
schema:
uniqueItems: true
type: array
items:
type: string
responses:
2XX:
description: Success
content:
application/json:
schema:
title: Collection of site
type: object
allOf:
- $ref: '#/components/schemas/BaseCollectionPaginationCountResponse'
- type: object
properties:
value:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.site'
4XX:
$ref: '#/components/responses/error'
5XX:
$ref: '#/components/responses/error'
x-ms-docs-operation-type: function
x-ms-pageable:
nextLinkName: '@odata.nextLink'
operationName: listMore
components:
schemas:
microsoft.graph.richLongRunningOperation:
allOf:
- $ref: '#/components/schemas/microsoft.graph.longRunningOperation'
- title: richLongRunningOperation
required:
- '@odata.type'
type: object
properties:
error:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.publicError'
- type: object
nullable: true
description: Error that caused the operation to fail.
percentageComplete:
maximum: 2147483647
minimum: -2147483648
type: number
description: A value between 0 and 100 that indicates the progress of the operation.
format: int32
nullable: true
resourceId:
type: string
description: The unique identifier for the result.
nullable: true
type:
type: string
description: The type of the operation.
nullable: true
'@odata.type':
type: string
description: The status of a long-running operation.
x-ms-discriminator-value: '#microsoft.graph.richLongRunningOperation'
microsoft.graph.workbookWorksheet:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: workbookWorksheet
required:
- '@odata.type'
type: object
properties:
name:
type: string
description: The display name of the worksheet.
nullable: true
position:
maximum: 2147483647
minimum: -2147483648
type: number
description: The zero-based position of the worksheet within the workbook.
format: int32
visibility:
type: string
description: 'The visibility of the worksheet. The possible values are: Visible, Hidden, VeryHidden.'
charts:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookChart'
description: The list of charts that are part of the worksheet. Read-only.
x-ms-navigationProperty: true
names:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookNamedItem'
description: The list of names that are associated with the worksheet. Read-only.
x-ms-navigationProperty: true
pivotTables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookPivotTable'
description: The list of piot tables that are part of the worksheet.
x-ms-navigationProperty: true
protection:
anyOf:
- $ref: '#/components/schemas/microsoft.graph.workbookWorksheetProtection'
- type: object
nullable: true
description: The sheet protection object for a worksheet. Read-only.
x-ms-navigationProperty: true
tables:
type: array
items:
$ref: '#/components/schemas/microsoft.graph.workbookTable'
description: The list of tables that are part of the worksheet. Read-only.
x-ms-navigationProperty: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.workbookWorksheet'
microsoft.graph.phoneType:
title: phoneType
enum:
- home
- business
- mobile
- other
- assistant
- homeFax
- businessFax
- otherFax
- pager
- radio
type: string
microsoft.graph.profilePhoto:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: profilePhoto
required:
- '@odata.type'
type: object
properties:
height:
maximum: 2147483647
minimum: -2147483648
type: number
description: The height of the photo. Read-only.
format: int32
nullable: true
width:
maximum: 2147483647
minimum: -2147483648
type: number
description: The width of the photo. Read-only.
format: int32
nullable: true
'@odata.type':
type: string
x-ms-discriminator-value: '#microsoft.graph.profilePhoto'
microsoft.graph.teamworkHostedContent:
allOf:
- $ref: '#/components/schemas/microsoft.graph.entity'
- title: teamworkHostedContent
required:
- '@odata.type'
type: object
properties:
contentBytes:
type: string
description: Write only. Bytes for the hosted content (such as images).
format: base64url
nullable: true
contentType:
type: string
description: Write only. Content type. such as image/png, image/jpg.
nullable: true
'@odata.type':
type: string
discriminator:
propertyName: '@odata.type'
mapping:
'#microsoft.graph.chatMessageHostedContent': '#/components/schemas/microsoft.graph.chatMessageHostedContent'
microsoft.graph.objectIdentity:
title: objectIdentity
required:
- '@odata.type'
type: object
properties:
issuer:
type: string
description: Specifies the issuer of the identity, for example facebook.com. 512 character limit. For local accounts (where signInType isn't federated), this property is the local default domain name for the tenant, for example contoso.com. For guests from other Microsoft Entra organizations, this is the domain of the federated organization, for example contoso.com. For more information about filtering behavior for this property, see Filtering on the identities property of a user.
nullable: true
issuerAssignedId:
type: string
description: 'Specifies the unique identifier assigned to the user by the issuer. 64 character limit. The combination of issuer and issuerAssignedId must be unique within the organization. Represents the sign-in name for the user, when signInType is
# --- truncated at 32 KB (1018 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/microsoft-graph/refs/heads/main/openapi/microsoft-graph-sites-site-functions-api-openapi.yml