---
updatedAt: 2026-03-30T13:36:55.000Z
agentTools:
  siteIndex: https://developer.bitmovin.com/llms.txt
  projectIndex: https://developer.bitmovin.com/playback/llms.txt
---

# Update Analytics License

# OpenAPI definition

```json
{
  "openapi": "3.0.1",
  "info": {
    "title": "Bitmovin API Reference",
    "description": "Bitmovins API Reference Description",
    "version": "3.1.1",
    "termsOfService": "https://bitmovin.com",
    "contact": {
      "name": "Bitmovin Inc",
      "url": "https://bitmovin.com",
      "email": "support@bitmovin.com"
    }
  },
  "servers": [
    {
      "url": "https://api.bitmovin.com/v1",
      "description": "Bitmovin Server",
      "variables": {}
    }
  ],
  "security": [
    {
      "ApiKeyAuth": []
    },
    {
      "ApiKeyAuth": [],
      "TenantOrgId": []
    }
  ],
  "paths": {
    "/analytics/licenses/{license_id}": {
      "put": {
        "tags": [
          "Licenses"
        ],
        "summary": "Update Analytics License",
        "operationId": "UpdateAnalyticsLicense",
        "parameters": [
          {
            "name": "license_id",
            "in": "path",
            "description": "License id",
            "style": "simple",
            "required": true,
            "schema": {
              "type": "string",
              "example": "4f80fcb3-fd0e-46b5-9c45-d91d7cab1b0d"
            }
          }
        ],
        "requestBody": {
          "description": "Analytics License details to be updated",
          "content": {
            "application/json": {
              "schema": {
                "$ref": "#/components/schemas/AnalyticsLicense"
              }
            }
          }
        },
        "responses": {
          "200": {
            "description": "Successful response.",
            "content": {
              "application/json": {
                "schema": {
                  "allOf": [
                    {
                      "$ref": "#/components/schemas/ResponseEnvelope"
                    },
                    {
                      "properties": {
                        "data": {
                          "properties": {
                            "result": {
                              "allOf": [
                                {
                                  "$ref": "#/components/schemas/AnalyticsLicense"
                                },
                                {
                                  "description": "Updated Analytics License"
                                }
                              ]
                            }
                          }
                        }
                      }
                    }
                  ]
                }
              }
            }
          },
          "default": {
            "description": "Error response.",
            "content": {
              "application/json": {
                "schema": {
                  "$ref": "#/components/schemas/ResponseError"
                }
              }
            }
          }
        }
      }
    }
  },
  "components": {
    "securitySchemes": {
      "ApiKeyAuth": {
        "type": "apiKey",
        "description": "Your Bitmovin API key",
        "name": "X-Api-Key",
        "in": "header"
      },
      "TenantOrgId": {
        "type": "apiKey",
        "description": "Your Bitmovin account organization",
        "name": "X-Tenant-Org-Id",
        "in": "header"
      }
    },
    "schemas": {
      "BitmovinResponse": {
        "title": "BitmovinResponse",
        "required": [
          "id"
        ],
        "properties": {
          "id": {
            "type": "string",
            "readOnly": true,
            "description": "Id of the resource",
            "example": "cb90b80c-8867-4e3b-8479-174aa2843f62"
          }
        }
      },
      "AnalyticsLicense": {
        "title": "AnalyticsLicense",
        "properties": {
          "id": {
            "readOnly": true,
            "type": "string",
            "description": "Id of the Analytics License",
            "example": "e6660f1b-5176-34c8-a66d-de6528c7519b"
          },
          "createdAt": {
            "readOnly": true,
            "type": "string",
            "format": "date-time",
            "description": "Creation date of the Analytics License, returned as ISO 8601 date-time format",
            "example": "2019-06-26T20:09:23.69Z"
          },
          "customData": {
            "readOnly": true,
            "type": "string",
            "description": "User-specific meta data. This can hold anything.",
            "additionalProperties": {
              "type": "object"
            }
          },
          "licenseKey": {
            "readOnly": true,
            "type": "string",
            "description": "License Key",
            "example": "470a6140-5174-44b8-a66d-675e1b1a947f"
          },
          "name": {
            "type": "string",
            "description": "Name of the Analytics License",
            "example": "My Analytics License"
          },
          "industry": {
            "readOnly": true,
            "type": "string",
            "description": "The industry of the organization associated with the Analytics License",
            "example": "Media"
          },
          "subIndustry": {
            "readOnly": true,
            "type": "string",
            "description": "The subindustry of the organization associated with the Analytics License",
            "example": "Broadcasting"
          },
          "ignoreDNT": {
            "type": "boolean",
            "description": "Whether the Do Not Track request from the browser should be ignored",
            "example": "false"
          },
          "impressions": {
            "readOnly": true,
            "type": "integer",
            "format": "int64",
            "description": "Number of impressions recorded",
            "example": "0"
          },
          "maxImpressions": {
            "readOnly": true,
            "type": "integer",
            "format": "int64",
            "description": "Maximum number of impressions",
            "example": "50000"
          },
          "timeZone": {
            "type": "string",
            "description": "The timezone of the Analytics License",
            "example": "+00:02"
          },
          "retentionTime": {
            "readOnly": true,
            "type": "string",
            "description": "Retention time of impressions, returned as ISO 8601 duration format: P(n)Y(n)M(n)DT(n)H(n)M(n)S",
            "example": "PT2952H"
          },
          "domains": {
            "readOnly": true,
            "type": "array",
            "description": "Whitelisted domains",
            "items": {
              "$ref": "#/components/schemas/AnalyticsLicenseDomain"
            }
          },
          "includeInInsights": {
            "readOnly": true,
            "type": "boolean",
            "description": "Whether the data of this license should be included in the industry insights or not",
            "example": "true"
          },
          "customDataFieldLabels": {
            "description": "Labels for CustomData fields",
            "allOf": [
              {
                "$ref": "#/components/schemas/AnalyticsLicenseCustomDataFieldLabels"
              }
            ]
          },
          "customDataFieldsCount": {
            "readOnly": true,
            "type": "integer",
            "description": "The number of customData fields available",
            "example": "5"
          },
          "orderIndex": {
            "readOnly": true,
            "type": "integer",
            "description": "Order index of license",
            "example": 1
          },
          "rateLimit": {
            "type": "string",
            "description": "The rate limit of this license",
            "example": "BASE"
          },
          "features": {
            "readOnly": true,
            "description": "Features settings",
            "$ref": "#/components/schemas/AnalyticsLicenseFeatures"
          },
          "planExpiredAt": {
            "readOnly": true,
            "type": "string",
            "format": "date-time",
            "description": "The expiration date of the license if applicable, returned as ISO 8601 date-time format",
            "example": "2023-06-28T14:29:49.93Z"
          }
        }
      },
      "AnalyticsLicenseCustomDataFieldLabels": {
        "title": "AnalyticsLicenseCustomDataFieldLabels",
        "properties": {
          "customData1": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 1",
            "example": "Mouse Clicked Event"
          },
          "customData2": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 2",
            "example": "Navigation Event"
          },
          "customData3": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 3",
            "example": "Customer data label"
          },
          "customData4": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 4",
            "example": "Ad Event"
          },
          "customData5": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 5",
            "example": "Video Library Name"
          },
          "customData6": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 6",
            "example": "Customer data label"
          },
          "customData7": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 7",
            "example": "Customer data label"
          },
          "customData8": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 8",
            "example": "Customer data label"
          },
          "customData9": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 9",
            "example": "Customer data label"
          },
          "customData10": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 10",
            "example": "Customer data label"
          },
          "customData11": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 11",
            "example": "Customer data label"
          },
          "customData12": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 12",
            "example": "Customer data label"
          },
          "customData13": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 13",
            "example": "Customer data label"
          },
          "customData14": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 14",
            "example": "Customer data label"
          },
          "customData15": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 15",
            "example": "Customer data label"
          },
          "customData16": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 16",
            "example": "Customer data label"
          },
          "customData17": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 17",
            "example": "Customer data label"
          },
          "customData18": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 18",
            "example": "Customer data label"
          },
          "customData19": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 19",
            "example": "Customer data label"
          },
          "customData20": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 20",
            "example": "Customer data label"
          },
          "customData21": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 21",
            "example": "Customer data label"
          },
          "customData22": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 22",
            "example": "Customer data label"
          },
          "customData23": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 23",
            "example": "Customer data label"
          },
          "customData24": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 24",
            "example": "Customer data label"
          },
          "customData25": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 25",
            "example": "Customer data label"
          },
          "customData26": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 26",
            "example": "Customer data label"
          },
          "customData27": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 27",
            "example": "Customer data label"
          },
          "customData28": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 28",
            "example": "Customer data label"
          },
          "customData29": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 29",
            "example": "Customer data label"
          },
          "customData30": {
            "type": "string",
            "maxLength": 100,
            "description": "Label for field Custom Data 30",
            "example": "Customer data label"
          }
        }
      },
      "AnalyticsLicenseFeatures": {
        "title": "AnalyticsLicenseFeatures",
        "properties": {
          "errorDetails": {
            "description": "Error details settings",
            "readOnly": true,
            "$ref": "#/components/schemas/AnalyticsLicenseErrorDetailsConfig"
          }
        }
      },
      "AnalyticsLicenseErrorDetailsConfig": {
        "title": "AnalyticsLicenseErrorDetailsConfig",
        "properties": {
          "enabled": {
            "type": "boolean",
            "readOnly": true,
            "description": "Are error details enabled on the license",
            "example": false
          },
          "networkExplorerEnabled": {
            "type": "boolean",
            "readOnly": true,
            "description": "Is network explorer feature enabled for the license",
            "example": false
          }
        }
      },
      "AnalyticsLicenseDomain": {
        "title": "AnalyticsLicenseDomain",
        "allOf": [
          {
            "$ref": "#/components/schemas/BitmovinResponse"
          },
          {
            "properties": {
              "url": {
                "type": "string"
              }
            }
          }
        ]
      },
      "Link": {
        "title": "Link",
        "required": [
          "href"
        ],
        "properties": {
          "href": {
            "type": "string",
            "description": "webpage target URL",
            "example": "https://bitmovin.com/encoding-documentation/bitmovin-api/#/reference/encoding/manifests/add-period"
          },
          "title": {
            "type": "string",
            "description": "Short description of the linked page",
            "example": "how to add a period to a manifest"
          }
        }
      },
      "Message": {
        "title": "Message",
        "required": [
          "type",
          "text"
        ],
        "allOf": [
          {
            "$ref": "#/components/schemas/BitmovinResponse"
          },
          {
            "properties": {
              "type": {
                "description": "Message type giving a hint on the importance of the message (log level)",
                "allOf": [
                  {
                    "$ref": "#/components/schemas/MessageType"
                  }
                ]
              },
              "text": {
                "type": "string",
                "description": "Message text",
                "example": "field must not be empty"
              },
              "field": {
                "type": "string",
                "description": "Name of the field to which the message is referring to",
                "example": "manifestId"
              },
              "links": {
                "type": "array",
                "items": {
                  "$ref": "#/components/schemas/Link"
                },
                "description": "collection of links to webpages containing further information on the topic"
              },
              "more": {
                "type": "object",
                "description": "Service-specific information"
              },
              "date": {
                "type": "string",
                "format": "date-time",
                "description": "Timestamp when the message occurred",
                "example": "2016-06-25T20:09:23.69Z"
              }
            }
          }
        ]
      },
      "MessageType": {
        "title": "MessageType",
        "type": "string",
        "enum": [
          "ERROR",
          "WARNING",
          "INFO",
          "DEBUG",
          "TRACE"
        ]
      },
      "ResponseEnvelope": {
        "title": "ResponseEnvelope",
        "required": [
          "requestId",
          "status",
          "data"
        ],
        "properties": {
          "requestId": {
            "type": "string",
            "readOnly": true,
            "description": "Unique correlation id",
            "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333"
          },
          "status": {
            "description": "Response status information",
            "readOnly": true,
            "example": "SUCCESS",
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ]
          },
          "data": {
            "description": "Response information",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/ResultWrapper"
              }
            ]
          },
          "more": {
            "type": "object",
            "description": "Additional endpoint specific information"
          }
        }
      },
      "ResponseError": {
        "title": "ResponseError",
        "required": [
          "requestId",
          "status",
          "data"
        ],
        "properties": {
          "requestId": {
            "type": "string",
            "readOnly": true,
            "description": "Unique correlation id",
            "example": "6d84e126-d10c-4e52-bbfb-bd4c92bc8333"
          },
          "status": {
            "description": "Response status information",
            "readOnly": true,
            "example": "ERROR",
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseStatus"
              }
            ]
          },
          "data": {
            "description": "Response information",
            "readOnly": true,
            "allOf": [
              {
                "$ref": "#/components/schemas/ResponseErrorData"
              }
            ]
          }
        }
      },
      "ResponseErrorData": {
        "title": "ResponseErrorData",
        "required": [
          "code",
          "message",
          "developerMessage"
        ],
        "properties": {
          "code": {
            "type": "integer",
            "readOnly": true,
            "description": "Contains an error code as defined in https://bitmovin.com/encoding-documentation/bitmovin-api/#/introduction/api-error-codes\n",
            "example": 1005
          },
          "message": {
            "type": "string",
            "readOnly": true,
            "description": "General error message"
          },
          "developerMessage": {
            "type": "string",
            "readOnly": true,
            "description": "More detailed message meant for developers"
          },
          "links": {
            "type": "array",
            "readOnly": true,
            "items": {
              "$ref": "#/components/schemas/Link"
            },
            "description": "collection of links to webpages containing further information on the topic"
          },
          "details": {
            "type": "array",
            "readOnly": true,
            "items": {
              "$ref": "#/components/schemas/Message"
            },
            "description": "collection of messages containing more detailed information on the cause of the error"
          }
        }
      },
      "ResponseStatus": {
        "title": "ResponseStatus",
        "type": "string",
        "enum": [
          "SUCCESS",
          "ERROR"
        ]
      },
      "ResultWrapper": {
        "title": "ResultWrapper",
        "properties": {
          "result": {
            "type": "object",
            "readOnly": true
          }
        }
      }
    }
  },
  "x-readme": {
    "explorer-enabled": true,
    "proxy-enabled": true
  }
}
```