{ "info": { "_postman_id": "e2cbf785-6c14-48f4-95ec-10b7efbe401c", "name": "Atlassian Marketplace API", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "App versions", "description": "Information about app versions", "item": [ { "name": "Get app versions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/versions", "query": [ { "key": "afterVersion", "value": "{{afterVersion}}", "disabled": true, "description": "Selects only app versions newer than the version with the specified display name" }, { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "includePrivate", "value": "{{includePrivate}}", "disabled": true, "description": "Includes private apps or versions if you are authorized to see them" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of versions for the specified app." }, "response": [] }, { "name": "Create app version", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/versions", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new version for the specified app.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get app version (by number)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/versions/build/:pluginBuildNumber", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "pluginBuildNumber", "value": "{{pluginBuildNumber}}", "description": "The unique internal identifier and sort key for this version", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the latest version of the specified app." }, "response": [] }, { "name": "Update app version", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/versions/build/:pluginBuildNumber", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "pluginBuildNumber", "value": "{{pluginBuildNumber}}", "description": "The unique internal identifier and sort key for this version", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json-patch+json" } ], "description": "Update a specific version for the specified app.\n\nThe request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw" } }, "response": [] }, { "name": "Get app version approval", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/versions/build/:pluginBuildNumber/approval", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "pluginBuildNumber", "value": "{{pluginBuildNumber}}", "description": "The unique internal identifier and sort key for this version", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app version approval status.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update app version approval", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/versions/build/:pluginBuildNumber/approval", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "pluginBuildNumber", "value": "{{pluginBuildNumber}}", "description": "The unique internal identifier and sort key for this version", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Approve, reject or resubmit an app version for approval.\n\nVendors can use this resource to resubmit a previously rejected app version for approval. This is done by setting the `status` field to `pending`.\n\nAdministrators can use this resource to approve or reject an app version that is submitted for approval.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get app version (latest)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/versions/latest", "query": [ { "key": "afterVersion", "value": "{{afterVersion}}", "disabled": true, "description": "Selects only app versions newer than the version with the specified display name" }, { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "includePrivate", "value": "{{includePrivate}}", "disabled": true, "description": "Includes private apps or versions if you are authorized to see them" } ], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the latest version of the specified app." }, "response": [] }, { "name": "Get app version (by name)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/versions/name/:name", "query": [ { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" } ], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "name", "value": "{{name}}", "description": "The display name of the version, for example \"1.0.0\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get details about a specific version, matching the specified name, of the specified app." }, "response": [] } ] }, { "name": "Applications", "description": "Information about applications", "item": [ { "name": "Get applications", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}applications", "query": [ { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of applications." }, "response": [] }, { "name": "Get application", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}applications/:applicationKey", "query": [], "variable": [ { "key": "applicationKey", "value": "{{applicationKey}}", "description": "The unique identifier for this application, for example \"jira\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific application." }, "response": [] }, { "name": "Get application versions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}applications/:applicationKey/versions", "query": [ { "key": "afterBuildNumber", "value": "{{afterBuildNumber}}", "disabled": true, "description": "Selects only application versions whose build number is greater than this" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [ { "key": "applicationKey", "value": "{{applicationKey}}", "description": "The unique identifier for this application, for example \"jira\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of versions for the specified application." }, "response": [] }, { "name": "Get application version (by number)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}applications/:applicationKey/versions/build/:applicationBuildNumber", "query": [], "variable": [ { "key": "applicationKey", "value": "{{applicationKey}}", "description": "The unique identifier for this application, for example \"jira\"", "disabled": false }, { "key": "applicationBuildNumber", "value": "{{applicationBuildNumber}}", "description": "The unique integer identifier for the application version", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get details about a specific version, matching the specified build number, of the specified application." }, "response": [] }, { "name": "Get application version (latest)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}applications/:applicationKey/versions/latest", "query": [], "variable": [ { "key": "applicationKey", "value": "{{applicationKey}}", "description": "The unique identifier for this application, for example \"jira\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the latest version of the specified application." }, "response": [] }, { "name": "Get application version (by name)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}applications/:applicationKey/versions/name/:name", "query": [], "variable": [ { "key": "applicationKey", "value": "{{applicationKey}}", "description": "The unique identifier for this application, for example \"jira\"", "disabled": false }, { "key": "name", "value": "{{name}}", "description": "The display name of the version, for example \"1.0.0\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get details about a specific version, matching the specified name, of the specified application." }, "response": [] } ] }, { "name": "Apps", "description": "Information about apps", "item": [ { "name": "Get apps", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "category", "value": "{{category}}", "disabled": true, "description": "Only returns apps with any of the specified categories" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "Return apps filtered or sorted using the specified parameter" }, { "key": "forThisUser", "value": "{{forThisUser}}", "disabled": true, "description": "Only returns apps from vendors associated with the current user" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "includeHidden", "value": "{{includeHidden}}", "disabled": true, "description": "Includes apps that are normally hidden in the site" }, { "key": "includePrivate", "value": "{{includePrivate}}", "disabled": true, "description": "Includes private apps or versions if you are authorized to see them" }, { "key": "marketingLabel", "value": "{{marketingLabel}}", "disabled": true, "description": "Only returns apps with the specified marketing labels" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Only returns apps that match the search text" }, { "key": "withVersion", "value": "{{withVersion}}", "disabled": true, "description": "Includes the latest compatible version in the response" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of apps matching the specified parameters." }, "response": [] }, { "name": "Create app", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new app.\n\nThe associated vendor account must exist prior to the app's creation. \n\nNote that the app's first version should be included in the request body (in `_embedded.version`).\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get archived apps", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/archived", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "category", "value": "{{category}}", "disabled": true, "description": "Only returns apps with any of the specified categories" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "Return apps filtered or sorted using the specified parameter" }, { "key": "forThisUser", "value": "{{forThisUser}}", "disabled": true, "description": "Only returns apps from vendors associated with the current user" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "includeHidden", "value": "{{includeHidden}}", "disabled": true, "description": "Includes apps that are normally hidden in the site" }, { "key": "includePrivate", "value": "{{includePrivate}}", "disabled": true, "description": "Includes private apps or versions if you are authorized to see them" }, { "key": "marketingLabel", "value": "{{marketingLabel}}", "disabled": true, "description": "Only returns apps with the specified marketing labels" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Only returns apps that match the search text" }, { "key": "withVersion", "value": "{{withVersion}}", "disabled": true, "description": "Includes the latest compatible version in the response" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of archived apps matching the specified parameters." }, "response": [] }, { "name": "Get archived apps (by vendor)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/archived/vendor/:vendorId", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "category", "value": "{{category}}", "disabled": true, "description": "Only returns apps with any of the specified categories" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "Return apps filtered or sorted using the specified parameter" }, { "key": "forThisUser", "value": "{{forThisUser}}", "disabled": true, "description": "Only returns apps from vendors associated with the current user" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "includeHidden", "value": "{{includeHidden}}", "disabled": true, "description": "Includes apps that are normally hidden in the site" }, { "key": "includePrivate", "value": "{{includePrivate}}", "disabled": true, "description": "Includes private apps or versions if you are authorized to see them" }, { "key": "marketingLabel", "value": "{{marketingLabel}}", "disabled": true, "description": "Only returns apps with the specified marketing labels" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Only returns apps that match the search text" }, { "key": "withVersion", "value": "{{withVersion}}", "disabled": true, "description": "Includes the latest compatible version in the response" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of archived apps by a specific vendor matching the specified parameters." }, "response": [] }, { "name": "Get app banners", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/listings/banners", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "category", "value": "{{category}}", "disabled": true, "description": "Only returns apps with any of the specified categories" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "Return apps filtered or sorted using the specified parameter" }, { "key": "forThisUser", "value": "{{forThisUser}}", "disabled": true, "description": "Only returns apps from vendors associated with the current user" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "includeHidden", "value": "{{includeHidden}}", "disabled": true, "description": "Includes apps that are normally hidden in the site" }, { "key": "includePrivate", "value": "{{includePrivate}}", "disabled": true, "description": "Includes private apps or versions if you are authorized to see them" }, { "key": "marketingLabel", "value": "{{marketingLabel}}", "disabled": true, "description": "Only returns apps with the specified marketing labels" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Only returns apps that match the search text" }, { "key": "withVersion", "value": "{{withVersion}}", "disabled": true, "description": "Includes the latest compatible version in the response" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of app banners matching the specified parameters." }, "response": [] }, { "name": "Get apps (brief)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/search/brief", "query": [ { "key": "q", "value": "{{q}}", "disabled": true, "description": "Text to search for" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of apps with names matching a search term. This resource's responses are limited to just a single page of results. Use the app collection resource (`/rest/2/addons`) for more results." }, "response": [] }, { "name": "Get apps (by vendor)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/vendor/:vendorId", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "category", "value": "{{category}}", "disabled": true, "description": "Only returns apps with any of the specified categories" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "Return apps filtered or sorted using the specified parameter" }, { "key": "forThisUser", "value": "{{forThisUser}}", "disabled": true, "description": "Only returns apps from vendors associated with the current user" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "includeHidden", "value": "{{includeHidden}}", "disabled": true, "description": "Includes apps that are normally hidden in the site" }, { "key": "includePrivate", "value": "{{includePrivate}}", "disabled": true, "description": "Includes private apps or versions if you are authorized to see them" }, { "key": "marketingLabel", "value": "{{marketingLabel}}", "disabled": true, "description": "Only returns apps with the specified marketing labels" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Only returns apps that match the search text" }, { "key": "withVersion", "value": "{{withVersion}}", "disabled": true, "description": "Includes the latest compatible version in the response" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of apps for the specified vendor." }, "response": [] }, { "name": "Get app", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "category", "value": "{{category}}", "disabled": true, "description": "Only returns apps with any of the specified categories" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "Return apps filtered or sorted using the specified parameter" }, { "key": "forThisUser", "value": "{{forThisUser}}", "disabled": true, "description": "Only returns apps from vendors associated with the current user" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "includeHidden", "value": "{{includeHidden}}", "disabled": true, "description": "Includes apps that are normally hidden in the site" }, { "key": "includePrivate", "value": "{{includePrivate}}", "disabled": true, "description": "Includes private apps or versions if you are authorized to see them" }, { "key": "marketingLabel", "value": "{{marketingLabel}}", "disabled": true, "description": "Only returns apps with the specified marketing labels" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Only returns apps that match the search text" }, { "key": "withVersion", "value": "{{withVersion}}", "disabled": true, "description": "Includes the latest compatible version in the response" } ], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app." }, "response": [] }, { "name": "Update app", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json-patch+json" } ], "description": "Update a specific app.\n\nThe request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw" } }, "response": [] }, { "name": "Get app approval", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/approval", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app approval status.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update app approval", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/approval", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Approve, reject or resubmit an app for approval.\n\nVendors can use this resource to resubmit a previously rejected app for approval. This is done by setting the `status` field to `pending`.\n\nAdministrators can use this resource to approve or reject an app that is submitted for approval.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get app metrics", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/distribution", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a summary of an app's latest metrics." }, "response": [] }, { "name": "Get app active installations", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/distribution/active", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app's active installation counts over time.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get app active installations (by application)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/distribution/application", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app's active installation counts over time, aggregated by application.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get app active installations (by application version)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/distribution/application/version", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app's active installation counts over time, aggregated by application version.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get app active installations (by major application version)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/distribution/application/version/major", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app's active installation counts over time, aggregated by major application version.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get app active installations (by minor application version)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/distribution/application/version/minor", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app's active installation counts over time, aggregated by minor application version.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get app active installations (by app version)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/distribution/version", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app's active installation counts over time, aggregated by app version.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get app feedback", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/feedbacks", "query": [ { "key": "type", "value": "{{type}}", "disabled": true, "description": "Return feedback for the specified feedback type only" }, { "key": "includeAnonymous", "value": "{{includeAnonymous}}", "disabled": true, "description": "Include anonymous feedback" }, { "key": "reason", "value": "{{reason}}", "disabled": true, "description": "Return feedback for the specified reason only" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of app feedback matching the specified parameters.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get aggregated app feedback", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/feedbacks/distribution", "query": [ { "key": "type", "value": "{{type}}", "disabled": false, "description": "Restricts the feedback distribution to the specified feedback type" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" } ], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get aggregated feedback for the specified app, aggregated by the specified metric.\n\nFeedback can be aggregated by type.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get app pricing", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/pricing/:cloudOrServer/:liveOrPending", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "cloudOrServer", "value": "{{cloudOrServer}}", "disabled": false }, { "key": "liveOrPending", "value": "{{liveOrPending}}", "description": "Specifies either the pricing that is currently in effect and visible to users (live), or pending that will take effect after a delay", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get pricing for the specified app. \n\nLive pricing is visible to all users. Pending pricing is only visible if you are authenticated as a vendor contact." }, "response": [] }, { "name": "Submit app pricing", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/pricing/:cloudOrServer/:liveOrPending", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "cloudOrServer", "value": "{{cloudOrServer}}", "disabled": false }, { "key": "liveOrPending", "value": "{{liveOrPending}}", "description": "Specifies either the pricing that is currently in effect and visible to users (live), or pending that will take effect after a delay", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update pricing for the specified app.\n\nUpdated pricing is always initially in the \"pending\" state.\n\nFor an app pending approval, pricing changes will go \"live\" when the app is approved. For an already-approved app, pricing changes will go \"live\" after 24 hours.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get app recommendations", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/recommendations", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "category", "value": "{{category}}", "disabled": true, "description": "Only returns apps with any of the specified categories" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "filter", "value": "{{filter}}", "disabled": true, "description": "Return apps filtered or sorted using the specified parameter" }, { "key": "forThisUser", "value": "{{forThisUser}}", "disabled": true, "description": "Only returns apps from vendors associated with the current user" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "includeHidden", "value": "{{includeHidden}}", "disabled": true, "description": "Includes apps that are normally hidden in the site" }, { "key": "includePrivate", "value": "{{includePrivate}}", "disabled": true, "description": "Includes private apps or versions if you are authorized to see them" }, { "key": "marketingLabel", "value": "{{marketingLabel}}", "disabled": true, "description": "Only returns apps with the specified marketing labels" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Only returns apps that match the search text" }, { "key": "withVersion", "value": "{{withVersion}}", "disabled": true, "description": "Includes the latest compatible version in the response" } ], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get apps recommended to users of the specified app." }, "response": [] }, { "name": "Get app release status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/release", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app's release status.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Release app", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/release", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Release an app after it has been approved.\n\nIf a vendor requests that their app is *not* automatically released after it has been approved, they can use this resource to release their app.\n\nSet the `released` field to `true`. This only works one-way; vendors cannot set it to `false` later.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get access tokens", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/tokens", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of access tokens for the specified app. \n\nIn addition to vendor contacts, anonymous users can access this resource if they provide an existing valid token." }, "response": [] }, { "name": "Create access token", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/tokens", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create a new access token.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get access token", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/tokens/:token", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "token", "value": "{{token}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific access token.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Validate access token", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/tokens/:token", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "token", "value": "{{token}}", "disabled": false } ] }, "method": "POST", "header": [], "description": "Validates or associates an access token with a host. \n\nFor a new access token, this resource associates the token with a host. For tokens already associated with a host, this resource validates that the `Origin` header matches the associated host. The host is specified by the request's `Origin` header." }, "response": [] }, { "name": "Delete access token", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/tokens/:token", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "token", "value": "{{token}}", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Delete a specific access token.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get watch/unwatch app state", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/watch", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns whether or not the current user is watching the specified app.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Watch / unwatch app", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/watch", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Updates whether or not the current user is watching the specified app.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Assets", "description": "For uploading app/image files", "item": [ { "name": "Get asset links", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}assets", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get links to permitted asset resources." }, "response": [] }, { "name": "Upload app artifact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}assets/artifact", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "multipart/form-data" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Use this resource to upload an app artifact (`.jar` or `.obr`) to Marketplace, so it can be used by an app version.\n\nThe request body is the file data.\n\nIf successful, the resource will respond with a resource link in `_links.self` that can be used as the `artifact` link when creating an app or app version. The response may include additional properties; other than `fileInfo`, these are used internally and should be ignored.\n\nThis resource requires authentication.\n\nExample: This curl command uploads the artifact present in a file ('my-file.jar').\n``` bash\ncurl --request POST \\\n --url https://marketplace.atlassian.com/rest/2/assets/artifact \\\n --user 'email@example.com:' \\\n --header 'Accept: application/json' \\\n --header 'Content-Type: multipart/form-data' \\\n --form file=@\"my-file.jar\"\n```", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "formdata", "formdata": [ { "key": "file", "description": "The relative location and name of the artifact file to be uploaded", "disabled": false, "type": "file" } ] } }, "response": [] }, { "name": "Validate app artifact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}assets/artifact/fetch", "query": [ { "key": "uri", "value": "{{uri}}", "disabled": false, "description": "Marketplace will attempt to download the artifact from this location" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Use this resource to copy and validate an app artifact (`.jar` or `.obr`) that is available from an external URL, so it can be used by an app version.\n\nIf successful, you will get a resource link in `_links.self` that can be used as the `artifact` link when creating an app or app version.\n\nNote that this step can be skipped by just setting the `artifact` link to the external URL where the artifact is hosted when creating an app version; Marketplace will then download the artifact automatically.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Upload image", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}assets/image/:imageType", "query": [ { "key": "file", "value": "{{file}}", "disabled": false, "description": "The logical filename" } ], "variable": [ { "key": "imageType", "value": "{{imageType}}", "description": "Specifies what this image will be used for, which determines the allowable image size", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Use this resource to upload an image (`.jpg`, `.png`, `.gif`, `.bmp`) to Marketplace, so you can use it for an app or vendor.\n\nThe request body is the file data.\n\nIf successful, you will get a resource link in _links.self that you can use as the appropriate image link in another resource, for example the `logo` link if you are creating an app.\n\nNote that if the image is available from an external URL, you can skip this step by just setting the image link tothat external URL when you are creating the resource that uses it.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get asset details", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}assets/:assetName", "query": [], "variable": [ { "key": "assetName", "value": "{{assetName}}", "description": "The unique identifying string that Marketplace uses to refer to this asset", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns details about a previously uploaded file that Marketplace is now storing.\n\nThe asset can either be an image file or an app artifact. If it is an app artifact, the response may include additional properties which are used internally and should be ignored." }, "response": [] }, { "name": "Delete asset", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}assets/:assetName", "query": [], "variable": [ { "key": "assetName", "value": "{{assetName}}", "description": "The unique identifying string that Marketplace uses to refer to this asset", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Removes a file from Marketplace storage which had been previously uploaded.\n\nThis is only allowed if:\n\n1. you, rather than another user, uploaded the file, and\n2. the asset is not currently being used by any other resource (for example, it cannot be the logo image for an existing app).\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Categories", "description": "Information about categories", "item": [ { "name": "Get categories", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addonCategories/app/:applicationKey", "query": [], "variable": [ { "key": "applicationKey", "value": "{{applicationKey}}", "description": "The unique identifier for this application, for example \"jira\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of categories associated with the parent application. \n\nFor non-UPM clients, this resource returns all categories regardless of the specified application." }, "response": [] }, { "name": "Get category", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addonCategories/:pluginCategoryId", "query": [], "variable": [ { "key": "pluginCategoryId", "value": "{{pluginCategoryId}}", "description": "The unique identifier for this category", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific category." }, "response": [] } ] }, { "name": "License types", "description": "Information about license types", "item": [ { "name": "Get license types", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}licenseTypes", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of license types." }, "response": [] }, { "name": "Get license type", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}licenseTypes/:licenseTypeKey", "query": [], "variable": [ { "key": "licenseTypeKey", "value": "{{licenseTypeKey}}", "description": "The unique identifier for this license type, for example \"gpl\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific license type." }, "response": [] } ] }, { "name": "Migrations", "description": "Information about app migration compatibility", "item": [ { "name": "Get migration info", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/migration", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get migration info about the Server/DC version for this app. All fields except addonName, addonKey and vendorId are optional and may not exist" }, "response": [] }, { "name": "Create migration info", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/migration", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create app migration information for consumption. All fields are optional", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Update migration info", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/migration", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json-patch+json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update migration information for this app. All fields except addonName, addonKey and vendorId are optional and may not exist", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw" } }, "response": [] } ] }, { "name": "Privacy and Security", "description": "Below are the APIs to fill privacy and security information about apps. We have also created a loom video for you that explains the process and steps involved.", "item": [ { "name": "Get app privacy and security information", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/privacy-and-security", "query": [ { "key": "state", "value": "{{state}}", "disabled": true, "description": "Specifies the version of Privacy and security information to be fetched. Possible values are \"live\" or \"draft\". For partners with manage app permissions, if a draft version exists then the default value will be \"draft\", or else the default value will be \"live\"." } ], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\".", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the privacy and security info for the specified app. This resource requires authentication for fetching \"draft\" version of privacy and security information.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create/Update app draft version of privacy and security info", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/privacy-and-security", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\".", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create/Update draft version of privacy and security info for the specified app. Any update will create a new draft version. This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete draft version of privacy and security info", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/privacy-and-security", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\".", "disabled": false } ] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Discards the draft version of privacy and security information for the specified app. This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update draft version of privacy and security info for the specific app", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/privacy-and-security", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\".", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json-patch+json" } ], "description": "Update draft version of privacy and security info for the specific app.\n\nThe request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw" } }, "response": [] }, { "name": "Publish app privacy and security info", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/privacy-and-security/publish", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\".", "disabled": false } ] }, "method": "PUT", "header": [], "description": "Publish the privacy and security info for the specified app. This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Products", "description": "Information about products", "item": [ { "name": "Get products", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}products", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "withVersion", "value": "{{withVersion}}", "disabled": true, "description": "Includes the latest compatible version in the response" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of products matching the specified parameters." }, "response": [] }, { "name": "Get product", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}products/key/:productKey", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "withVersion", "value": "{{withVersion}}", "disabled": true, "description": "Includes the latest compatible version in the response" } ], "variable": [ { "key": "productKey", "value": "{{productKey}}", "description": "The unique identifier for this product, for example \"jira-software\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific product." }, "response": [] }, { "name": "Get product versions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}products/key/:productKey/versions", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [ { "key": "productKey", "value": "{{productKey}}", "description": "The unique identifier for this product, for example \"jira-software\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of versions for the specified product." }, "response": [] }, { "name": "Get product version (by number)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}products/key/:productKey/versions/build/:buildNumber", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" } ], "variable": [ { "key": "productKey", "value": "{{productKey}}", "description": "The unique identifier for this product, for example \"jira-software\"", "disabled": false }, { "key": "buildNumber", "value": "{{buildNumber}}", "description": "The unique internal identifier and sort key for this version", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get details about a specific version, matching the specified build number, of the specified product." }, "response": [] }, { "name": "Get product version (latest)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}products/key/:productKey/versions/latest", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" } ], "variable": [ { "key": "productKey", "value": "{{productKey}}", "description": "The unique identifier for this product, for example \"jira-software\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the latest version of the specified product." }, "response": [] }, { "name": "Get product version (by name)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}products/key/:productKey/versions/name/:versionName", "query": [ { "key": "application", "value": "{{application}}", "disabled": true, "description": "Only returns apps compatible with this application" }, { "key": "applicationBuild", "value": "{{applicationBuild}}", "disabled": true, "description": "Only returns apps compatible with the specified application build number" }, { "key": "cost", "value": "{{cost}}", "disabled": true, "description": "Only returns apps with the specified payment model" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" } ], "variable": [ { "key": "productKey", "value": "{{productKey}}", "description": "The unique identifier for this product, for example \"jira-software\"", "disabled": false }, { "key": "versionName", "value": "{{versionName}}", "description": "The display name of the version, for example \"1.0.0\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get details about a specific version, matching the specified name, of the specified product." }, "response": [] } ] }, { "name": "Promotions (Removed)", "description": "Information about vendor promotions", "item": [ { "name": "Get promotions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/promotions", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of promotions for the specified vendor.\n\nThis resource requires authentication.\n\n**This is a deprecated API. Refer [Get promotions](/platform/marketplace/rest/v1/api-group-promotions/#api-marketplace-catalog-partners-partnerid-promotions-get) for the new API details**", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create promotion", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/promotions", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new promotion for the specified vendor.\n\nThis resource requires authentication.\n\n**This is a deprecated API. Refer [Create promotion](/platform/marketplace/rest/v1/api-group-promotions/#api-marketplace-catalog-partners-partnerid-promotions-post) for the new API details**", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get promotion", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/promotions/:promotionId", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "promotionId", "value": "{{promotionId}}", "description": "The unique identifier for this promotion", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific promotion for the specified vendor.\n\nThis resource requires authentication.\n\n**This is a deprecated API. Refer [Get promotion](/platform/marketplace/rest/v1/api-group-promotions/#api-marketplace-catalog-partners-partnerid-promotions-promotionid-get) for the new API details**", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update promotion", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/promotions/:promotionId", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "promotionId", "value": "{{promotionId}}", "description": "The unique identifier for this promotion", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json-patch+json" } ], "description": "Update a specific promotion for the specified vendor.\n\nThe request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.\n\nThis resource requires authentication.\n\n**This is a deprecated API. Refer [Update promotion](/platform/marketplace/rest/v1/api-group-promotions/#api-marketplace-catalog-partners-partnerid-promotions-promotionid-patch) for the new API details**", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw" } }, "response": [] }, { "name": "Get promotion codes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/promotions/:promotionId/codes", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "promotionId", "value": "{{promotionId}}", "description": "The unique identifier for this promotion", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of single-use codes for the specified promotion.\n\nThis resource requires authentication.\n\n**This is a deprecated API. Refer [Get promotion codes](/platform/marketplace/rest/v1/api-group-promotions/#api-marketplace-catalog-partners-partnerid-promotions-promotionid-codes-get) for the new API details**", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create promotion code", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/promotions/:promotionId/codes", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "promotionId", "value": "{{promotionId}}", "description": "The unique identifier for this promotion", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Create a new single-use code for the specified promotion.\n\nThis resource requires authentication.\n\n**This is a deprecated API. Refer [Create promotion code](/platform/marketplace/rest/v1/api-group-promotions/#api-marketplace-catalog-partners-partnerid-promotions-promotionid-codes-post) for the new API details**", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get promotion code", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/promotions/:promotionId/codes/:promotionCode", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "promotionId", "value": "{{promotionId}}", "description": "The unique identifier for this promotion", "disabled": false }, { "key": "promotionCode", "value": "{{promotionCode}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific single-use code for the specified promotion.\n\nThis resource requires authentication.\n\n**This is a deprecated API. Refer [Get promotion code](/platform/marketplace/rest/v1/api-group-promotions/#api-marketplace-catalog-partners-partnerid-promotions-promotionid-codes-promotioncode-get) for the new API details**", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete promotion code", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/promotions/:promotionId/codes/:promotionCode", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "promotionId", "value": "{{promotionId}}", "description": "The unique identifier for this promotion", "disabled": false }, { "key": "promotionCode", "value": "{{promotionCode}}", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete a specific single-use code for a specific promotion associated with a specific vendor. \n\nPromotion codes can only be deleted prior to their use.\n\nThis resource requires authentication.\n\n**This is a deprecated API. Refer [Delete promotion code](/platform/marketplace/rest/v1/api-group-promotions/#api-marketplace-catalog-partners-partnerid-promotions-promotionid-codes-promotioncode-delete) for the new API details**", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get promotion status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/promotions/:promotionId/status", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "promotionId", "value": "{{promotionId}}", "description": "The unique identifier for this promotion", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific promotion status for the specified vendor.\n\nThis resource requires authentication.\n\n**This is a deprecated API. Refer [Get promotion status](/platform/marketplace/rest/v1/api-group-promotions/#api-marketplace-catalog-partners-partnerid-promotions-promotionid-status-get) for the new API details**", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Reporting", "description": "Information about vendor reporting", "item": [ { "name": "Get reporting links", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get links to permitted vendor reporting resources.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get aggregated evaluations", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/evaluations/:metric", "query": [ { "key": "aggregation", "value": "{{aggregation}}", "disabled": true, "description": "The time aggregation" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "metric", "value": "{{metric}}", "description": "The unique identifier for this evaluation metric", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get aggregated evaluations for the specified vendor, aggregated by the specified metric.\n\nEvaluations can be aggregated by hosting, region, and more.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get feedback", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/feedback/details", "query": [ { "key": "type", "value": "{{type}}", "disabled": true, "description": "Restrict feedback to the specified type" }, { "key": "anonymous", "value": "{{anonymous}}", "disabled": true, "description": "Restrict feedback to feedback that is either anonymous or by a known user" }, { "key": "reason", "value": "{{reason}}", "disabled": true, "description": "Restrict feedback to the specified reason" }, { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Restricts the query to values for these hosting types" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Text to search for in the reporter details (license id, email address, appEntitlementId, appEntitlementNumber, cloudID and the optional message)" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items. Max limit is 50" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of feedback for the specified vendor's apps.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Export feedback", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/feedback/details/export", "query": [ { "key": "type", "value": "{{type}}", "disabled": true, "description": "Restrict feedback to the specified type" }, { "key": "anonymous", "value": "{{anonymous}}", "disabled": true, "description": "Restrict feedback to feedback that is either anonymous or by a known user" }, { "key": "reason", "value": "{{reason}}", "disabled": true, "description": "Restrict feedback to the specified reason" }, { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Restricts the query to values for these hosting types" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Text to search for in the reporter details (license id and email address) and the optional message" }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [], "description": "Export all feedback, matching the specified filters, for the specified vendor's apps.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get aggregated feedback", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/feedback/metrics/:metric", "query": [ { "key": "aggregation", "value": "{{aggregation}}", "disabled": true, "description": "The time aggregation" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "metric", "value": "{{metric}}", "description": "The unique identifier for this vendor feedback metric", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get aggregated feedback for the specified vendor, aggregated by the specified metric.\n\nFeedback can be aggregated by type and reason.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get licenses", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/licenses", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Text to search for in license fields (license id, customer information and partner information)" }, { "key": "tier", "value": "{{tier}}", "disabled": true, "description": "Restricts the query to values for these user/edition tiers" }, { "key": "dateType", "value": "{{dateType}}", "disabled": true, "description": "The date field against which filters will be applied" }, { "key": "licenseType", "value": "{{licenseType}}", "disabled": true, "description": "If specified, restricts the query to values with the provided license type." }, { "key": "partnerType", "value": "{{partnerType}}", "disabled": true, "description": "Specifies whether to query only direct sales, expert sales, or reseller sales" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Restricts the query to values for these hosting types" }, { "key": "status", "value": "{{status}}", "disabled": true, "description": "If specified, restricts the query to values with the provided status" }, { "key": "withAttribution", "value": "{{withAttribution}}", "disabled": true, "description": "This field is deprecated. Please use withDataInsights to obtain additional data insights. If specified, retrieve marketing funnel attribution data" }, { "key": "withDataInsights", "value": "{{withDataInsights}}", "disabled": true, "description": "If specified, retrieve additional data insights - marketing funnel attribution, evaluation opportunity size and evaluation to sale insights. This will only be applicable if startDate is after July, 2018." }, { "key": "includeAtlassianLicenses", "value": "{{includeAtlassianLicenses}}", "disabled": true, "description": "If true, include internal Atlassian licenses in the report" }, { "key": "lastUpdated", "value": "{{lastUpdated}}", "disabled": true, "description": "If specified, restricts the query to values updated on or after the specified date" }, { "key": "sortBy", "value": "{{sortBy}}", "disabled": true, "description": "If specified, determines the license sort order" }, { "key": "order", "value": "{{order}}", "disabled": true, "description": "Determines whether values are sorted in ascending or descending order" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items. Max limit is 50" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of licenses for the specified vendor's apps.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Export licenses", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/licenses/export", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Text to search for in license fields (license id, customer information and partner information)" }, { "key": "tier", "value": "{{tier}}", "disabled": true, "description": "Restricts the query to values for these user/edition tiers" }, { "key": "dateType", "value": "{{dateType}}", "disabled": true, "description": "The date field against which filters will be applied" }, { "key": "licenseType", "value": "{{licenseType}}", "disabled": true, "description": "If specified, restricts the query to values with the provided license type; 'inactive' queries for expired licenses. Queries for 'starter' are deprecated; results may not be as expected" }, { "key": "partnerType", "value": "{{partnerType}}", "disabled": true, "description": "Specifies whether to query only direct sales, expert sales, or reseller sales" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Restricts the query to values for these hosting types" }, { "key": "status", "value": "{{status}}", "disabled": true, "description": "If specified, restricts the query to values with the provided status" }, { "key": "withAttribution", "value": "{{withAttribution}}", "disabled": true, "description": "This field is deprecated. Please use withDataInsights to obtain additional data insights. If specified, retrieve marketing funnel attribution data" }, { "key": "withDataInsights", "value": "{{withDataInsights}}", "disabled": true, "description": "If specified, retrieve additional data insights - marketing funnel attribution, evaluation opportunity size and evaluation to sale insights. This will only be applicable if startDate is after July, 2018." }, { "key": "includeAtlassianLicenses", "value": "{{includeAtlassianLicenses}}", "disabled": true, "description": "If true, include internal Atlassian licenses in the report" }, { "key": "lastUpdated", "value": "{{lastUpdated}}", "disabled": true, "description": "If specified, restricts the query to values updated on or after the specified date" }, { "key": "sortBy", "value": "{{sortBy}}", "disabled": true, "description": "If specified, determines the license sort order" }, { "key": "order", "value": "{{order}}", "disabled": true, "description": "Determines whether values are sorted in ascending or descending order" }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [], "description": "Export all licenses, matching the specified filters, for the specified vendor's apps.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Initiate Async Export licenses", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/licenses/async/export", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Text to search for in license fields (license id, customer information and partner information)" }, { "key": "tier", "value": "{{tier}}", "disabled": true, "description": "Restricts the query to values for these user/edition tiers" }, { "key": "dateType", "value": "{{dateType}}", "disabled": true, "description": "The date field against which filters will be applied" }, { "key": "licenseType", "value": "{{licenseType}}", "disabled": true, "description": "If specified, restricts the query to values with the provided license type; 'inactive' queries for expired licenses. Queries for 'starter' are deprecated; results may not be as expected" }, { "key": "partnerType", "value": "{{partnerType}}", "disabled": true, "description": "Specifies whether to query only direct sales, expert sales, or reseller sales" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Restricts the query to values for these hosting types" }, { "key": "status", "value": "{{status}}", "disabled": true, "description": "If specified, restricts the query to values with the provided status" }, { "key": "withAttribution", "value": "{{withAttribution}}", "disabled": true, "description": "This field is deprecated. Please use withDataInsights to obtain additional data insights. If specified, retrieve marketing funnel attribution data" }, { "key": "withDataInsights", "value": "{{withDataInsights}}", "disabled": true, "description": "If specified, retrieve additional data insights - marketing funnel attribution, evaluation opportunity size and evaluation to sale insights. This will only be applicable if startDate is after July, 2018." }, { "key": "includeAtlassianLicenses", "value": "{{includeAtlassianLicenses}}", "disabled": true, "description": "If true, include internal Atlassian licenses in the report" }, { "key": "lastUpdated", "value": "{{lastUpdated}}", "disabled": true, "description": "If specified, restricts the query to values updated on or after the specified date" }, { "key": "sortBy", "value": "{{sortBy}}", "disabled": true, "description": "If specified, determines the license sort order" }, { "key": "order", "value": "{{order}}", "disabled": true, "description": "Determines whether values are sorted in ascending or descending order" }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Initiate a POST request to export all licenses that match the specified filters for the vendor's apps. This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get status Async Export licenses", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/licenses/async/export/:exportId/status", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "exportId", "value": "{{exportId}}", "description": "Unique export id for license export", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get status for async export license request", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Download Async Export licenses", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/licenses/async/export/:exportId", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "exportId", "value": "{{exportId}}", "description": "Unique export id for transaction export", "disabled": false } ] }, "method": "GET", "header": [], "description": "Download async export licenses", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Initiate Async Export marketing attribution", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/marketing-attribution/async/export", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query (based on eventTimestamp field)" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query (based on eventTimestamp field)" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Text to search for in marketing attribution fields (license id, channel and campaign name)" }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Initiate a POST request to export all marketing attribution data that matches the specified filters for the vendor's apps. The data will include customer activities on app related pages in the last 30 days before start of evaluation. This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get status Async Export marketing attribution", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/async/export/:exportId/status", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "exportId", "value": "{{exportId}}", "description": "Unique export id for marketing attribution export", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get status for async export marketing attribution request.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Download Async Export marketing attribution", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/async/export/:exportId", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "exportId", "value": "{{exportId}}", "description": "Unique export id for marketing attribution export", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Download async export marketing attribution.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Cloud churn", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/metrics/churn", "query": [ { "key": "aggregation", "value": "{{aggregation}}", "disabled": true, "description": "The time aggregation" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of Cloud churn events for the specified vendor's apps.\n\nFor a given period, churn is calculated as the number of paying customers that have an opportunity to renew and choose to stop paying.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Cloud conversions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/metrics/conversion", "query": [ { "key": "aggregation", "value": "{{aggregation}}", "disabled": true, "description": "The time aggregation" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of Cloud conversion events for the specified vendor's apps.\n\nFor a given period, conversions are calculated as the number of evaluation licenses that converted into paid licenses.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Cloud renewals", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/metrics/renewal", "query": [ { "key": "aggregation", "value": "{{aggregation}}", "disabled": true, "description": "The time aggregation" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of Cloud renewal events for the specified vendor's apps.\n\nFor a given period, renewals are calculated as the number of paying customers that have an opportunity to renew and choose to continue paying.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Cloud license events", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/metrics/:saleMetric/details", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Restricts the query to values for these hosting types" }, { "key": "lastUpdated", "value": "{{lastUpdated}}", "disabled": true, "description": "If specified, restricts the query to values updated on or after the specified date" }, { "key": "partnerType", "value": "{{partnerType}}", "disabled": true, "description": "Specifies whether to query only direct sales, expert sales, or reseller sales" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Text to search for (transaction id, license id, customer information and partner information)" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" }, { "key": "sortBy", "value": "{{sortBy}}", "disabled": true, "description": "If specified, determines the data sort order" }, { "key": "order", "value": "{{order}}", "disabled": true, "description": "Determines whether values are sorted in ascending or descending order" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "saleMetric", "value": "{{saleMetric}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the details about an individual Cloud license event (churn, conversion or renewal) for a specific vendor's apps.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Export Cloud license events", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/metrics/:saleMetric/details/export", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Restricts the query to values for these hosting types" }, { "key": "lastUpdated", "value": "{{lastUpdated}}", "disabled": true, "description": "If specified, restricts the query to values updated on or after the specified date" }, { "key": "partnerType", "value": "{{partnerType}}", "disabled": true, "description": "Specifies whether to query only direct sales, expert sales, or reseller sales" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Text to search for (transaction id, license id, customer information and partner information)" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" }, { "key": "sortBy", "value": "{{sortBy}}", "disabled": true, "description": "If specified, determines the data sort order" }, { "key": "order", "value": "{{order}}", "disabled": true, "description": "Determines whether values are sorted in ascending or descending order" }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "saleMetric", "value": "{{saleMetric}}", "disabled": false } ] }, "method": "GET", "header": [], "description": "Export all Cloud license events, matching the specified filters, for the specified vendor's apps.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get transactions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/transactions", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Text to search for in transaction fields (transaction id, license id, customer information and partner information)" }, { "key": "tier", "value": "{{tier}}", "disabled": true, "description": "Restricts the query to values for these user/edition tiers" }, { "key": "saleType", "value": "{{saleType}}", "disabled": true, "description": "Restricts the query to sales of these types" }, { "key": "partnerType", "value": "{{partnerType}}", "disabled": true, "description": "Specifies whether to query only direct sales, expert sales, or reseller sales" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Restricts the query to values for these hosting types" }, { "key": "lastUpdated", "value": "{{lastUpdated}}", "disabled": true, "description": "If specified, restricts the query to values updated on or after the specified date" }, { "key": "excludeZeroTransactions", "value": "{{excludeZeroTransactions}}", "disabled": true, "description": "If set to true, exclude $0 transactions from reports" }, { "key": "paymentStatus", "value": "{{paymentStatus}}", "disabled": true, "description": "Restricts the query to payment status of these types" }, { "key": "sortBy", "value": "{{sortBy}}", "disabled": true, "description": "If specified, determines the transaction sort order" }, { "key": "order", "value": "{{order}}", "disabled": true, "description": "Determines whether values are sorted in ascending or descending order" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items. Max limit is 50" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of transactions for the specified vendor's apps.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Export transactions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/transactions/export", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Text to search for in transaction fields (transaction id, license id, customer information and partner information)" }, { "key": "tier", "value": "{{tier}}", "disabled": true, "description": "Restricts the query to values for these user/edition tiers" }, { "key": "saleType", "value": "{{saleType}}", "disabled": true, "description": "Restricts the query to sales of these types" }, { "key": "partnerType", "value": "{{partnerType}}", "disabled": true, "description": "Specifies whether to query only direct sales, expert sales, or reseller sales" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Restricts the query to values for these hosting types" }, { "key": "lastUpdated", "value": "{{lastUpdated}}", "disabled": true, "description": "If specified, restricts the query to values updated on or after the specified date" }, { "key": "excludeZeroTransactions", "value": "{{excludeZeroTransactions}}", "disabled": true, "description": "If set to true, exclude $0 transactions from reports" }, { "key": "paymentStatus", "value": "{{paymentStatus}}", "disabled": true, "description": "Restricts the query to payment status of these types" }, { "key": "sortBy", "value": "{{sortBy}}", "disabled": true, "description": "If specified, determines the transaction sort order" }, { "key": "order", "value": "{{order}}", "disabled": true, "description": "Determines whether values are sorted in ascending or descending order" }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [], "description": "Export all transactions, matching the specified filters, for the specified vendor's apps.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Initiate Async Export transactions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/transactions/async/export", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Text to search for in transaction fields (transaction id, license id, customer information and partner information)" }, { "key": "tier", "value": "{{tier}}", "disabled": true, "description": "Restricts the query to values for these user/edition tiers" }, { "key": "saleType", "value": "{{saleType}}", "disabled": true, "description": "Restricts the query to sales of these types" }, { "key": "partnerType", "value": "{{partnerType}}", "disabled": true, "description": "Specifies whether to query only direct sales, expert sales, or reseller sales" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Restricts the query to values for these hosting types" }, { "key": "lastUpdated", "value": "{{lastUpdated}}", "disabled": true, "description": "If specified, restricts the query to values updated on or after the specified date" }, { "key": "excludeZeroTransactions", "value": "{{excludeZeroTransactions}}", "disabled": true, "description": "If set to true, exclude $0 transactions from reports" }, { "key": "paymentStatus", "value": "{{paymentStatus}}", "disabled": true, "description": "Restricts the query to payment status of these types" }, { "key": "sortBy", "value": "{{sortBy}}", "disabled": true, "description": "If specified, determines the transaction sort order" }, { "key": "order", "value": "{{order}}", "disabled": true, "description": "Determines whether values are sorted in ascending or descending order" }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Initiate a POST request to export all transactions that match the specified filters for the vendor's apps. This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Status Async Export transactions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/transactions/async/export/:exportId/status", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "exportId", "value": "{{exportId}}", "description": "Unique export id for transaction export", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get status for async export transaction request", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Download Async Export transactions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/transactions/async/export/:exportId", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "exportId", "value": "{{exportId}}", "description": "Unique export id for transaction export", "disabled": false } ] }, "method": "GET", "header": [], "description": "Download async export transactions", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get aggregated sales", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/transactions/:metric", "query": [ { "key": "aggregation", "value": "{{aggregation}}", "disabled": true, "description": "The time aggregation" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "metric", "value": "{{metric}}", "description": "The unique identifier for this sale metric", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get aggregated sales for the specified vendor, aggregated by the specified metric.\n\nSales can be aggregated by hosting, region, and more.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Export free starter tier entitlements", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/freeStarterTier/export", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "includeAtlassianLicenses", "value": "{{includeAtlassianLicenses}}", "disabled": true, "description": "If true, include internal Atlassian licenses in the report" }, { "key": "date", "value": "{{date}}", "disabled": true, "description": "If specified, restricts the query to the entitlements of the specified date. If not specified, gives the entitlements for the last valid date" }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [], "description": "Export entitlements under free starter tier plan, matching the specified filters, for the specified vendor's apps.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Cloud churn benchmark", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/sales/metrics/churn/benchmark", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "The unique identifier for an app" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get cloud churn benchmark for the specified vendor's apps.\n\n This feature enables to have a deeper understanding of cloud churn numbers and allows to compare app performance to all other cloud apps on Marketplace.\n\n This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Cloud evaluation benchmark", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/benchmark/evaluations", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "The unique identifier for an app" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query and should be in the format **YYYY-MM-DD** and startDate will always be the start of the month irrespective of the date you provide. For example: if startDate entered is 2022-01-22, it will reflect as 2022-01-01" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query and should be in the format **YYYY-MM-DD** and and endDate will always be the start of the month irrespective of the date you provide. For example: if endDate entered is 2022-01-22, it will reflect as 2022-01-01" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "To fetch count of evaluations and benchmark.\nThis resource returns monthly and year-to-date count of evaluations, and their Month over Month and Year over Year growth respectively. It also returns benchmarks for the growth figures by comparing them against overall Marketplace growth.\n\n This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Cloud sales benchmark", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/benchmark/sales", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query and should be in the format **YYYY-MM-DD** and startDate will always be the start of the month irrespective of the data you provide.\n\n For example: If startDate entered is 2022-01-22, it will reflect as 2022-01-01" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query and should be in the format **YYYY-MM-DD** and endDate will always be the start of the month irrespective of the data you provide.\n\n For example: If endDate entered is 2022-01-22, it will reflect as 2022-01-01" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "To fetch cloud sales and benchmark for the specified partner and partner's apps. It includes only partner share of sales and does not include Atlassian share.\nThis resource returns monthly and year-to-date sales value from marketplace transactions, and their Month over Month and Year over Year growth respectively. It also returns benchmarks for the growth figures by comparing them against overall Marketplace growth and base product growth.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Customer Insights (By Region)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/customer-insights/regions", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query and should be in the format **YYYY-MM-DD** and startDate will always be the start of the month irrespective of the data you provide.\n\n For example: If startDate entered is 2022-01-22, it will reflect as 2022-01-01" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query and should be in the format **YYYY-MM-DD** and endDate will always be the start of the month irrespective of the data you provide.\n\n For example: If endDate entered is 2022-01-22, it will reflect as 2022-01-01" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "To fetch count of customers split by region and percentage distribution of customers across regions (APAC, EMEA, Americas, Unknown).\nIt also returns a benchmark of the percentage distribution by comparing it against overall Marketplace distribution.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Customer Insights (By Edition)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/customer-insights/editions", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query and should be in the format **YYYY-MM-DD** and startDate will always be the start of the month irrespective of the data you provide. For example: if startDate entered is 2022-01-22, it will reflect as 2022-01-01" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query and should be in the format **YYYY-MM-DD** and endDate will always be the start of the month irrespective of the data you provide. For example: if endDate entered is 2022-01-22, it will reflect as 2022-01-01" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "To fetch count of customers split by parent product edition and percentage distribution of customers across parent product editions.\nIt also returns a benchmark of the percentage distribution by comparing it against overall Marketplace distribution.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Customer Insights (By ActiveUsers)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/customer-insights/active-users", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query. Should be in the format **YYYY-MM-DD**. startDate will always be the start of the month irrespective of the data you provide. For example: if startDate entered is 2022-01-22, it will reflect as 2022-01-01. " }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query. Should be of the format **YYYY-MM-DD**. endDate will always be the start of the month irrespective of the data you provide. For example: if endDate entered is 2022-01-22, it will reflect as 2022-01-01" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "To fetch count of customers using a paid instance of Jira or Confluence and the count as a percentage of total customers.\nIt also returns a benchmark of the percentage value by comparing it against overall Marketplace average.\n\n This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Customer Insights (By Tier)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/customer-insights/tiers", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query. Should be in the format **YYYY-MM-DD**. startDate will always be the start of the month irrespective of the data you provide. For example: if startDate entered is 2022-01-22, it will reflect as 2022-01-01. " }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query. Should be of the format **YYYY-MM-DD**. endDate will always be the start of the month irrespective of the data you provide. For example: if endDate entered is 2022-01-22, it will reflect as 2022-01-01." }, { "key": "product", "value": "{{product}}", "disabled": true, "description": "Parent product type. For example: Jira or Confluence." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "To fetch count of customers split by user tier and percentage distribution of customers across user tiers. User tier indicates the count of users on Jira or Confluence instance (1 to 10, 11 to 100, 101 to 1000, etc.).\nIt also returns a benchmark of the percentage distribution by comparing it against overall Marketplace distribution.\n\n This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Top Search Keywords (By source)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/search-keywords/source/:sourceKey", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query. Should be in the format **YYYY-MM-DD**." }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query. Should be in the format **YYYY-MM-DD**." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner.", "disabled": false }, { "key": "sourceKey", "value": "{{sourceKey}}", "description": "The unique identifier for the source type", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the list of top 500 searched keywords on the basis of source type.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Export Top Search Keywords (By source)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/search-keywords/source/:sourceKey/export", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query. Should be in the format **YYYY-MM-DD**." }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query. Should be in the format **YYYY-MM-DD**." }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner.", "disabled": false }, { "key": "sourceKey", "value": "{{sourceKey}}", "description": "The unique identifier for the source type", "disabled": false } ] }, "method": "GET", "header": [], "description": "Export the list of top 500 searched keywords on the basis of source type. \n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Zero Search Results Keywords", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/zero-search-results-keywords/source/:sourceKey", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query and should be in the format **YYYY-MM-DD**." }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query and should be in the format **YYYY-MM-DD**." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor.", "disabled": false }, { "key": "sourceKey", "value": "{{sourceKey}}", "description": "The unique identifier for the source type", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get zero search results keywords on the basis of source type. This feature will help to have deeper understanding of searched keywords that have zero search results and thereby discover the opportunity to build apps.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Export Zero Search Results Keywords", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/zero-search-results-keywords/source/:sourceKey/export", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query and should be in the format **YYYY-MM-DD**." }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query and should be in the format **YYYY-MM-DD**." }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor.", "disabled": false }, { "key": "sourceKey", "value": "{{sourceKey}}", "description": "The unique identifier for the source type", "disabled": false } ] }, "method": "GET", "header": [], "description": "Export zero search results keywords on the basis of source type. This feature will help to have deeper understanding of searched keywords that have zero search results and thereby discover the opportunity to build apps.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Search Keywords (By Partner)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/search-keywords", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query. Should be in the format **YYYY-MM-DD**." }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query. Should be in the format **YYYY-MM-DD**." }, { "key": "aggregation", "value": "{{aggregation}}", "disabled": true, "description": "The time aggregation" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get aggregated searched keywords detail which includes top search keyword and total search appearances for all the apps from the specified partner. \n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Export Search Keywords (By Partner)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/search-keywords/export", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query. Should be in the format **YYYY-MM-DD**." }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query. Should be in the format **YYYY-MM-DD**." }, { "key": "aggregation", "value": "{{aggregation}}", "disabled": true, "description": "The time aggregation" }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner.", "disabled": false } ] }, "method": "GET", "header": [], "description": "Export aggregated searched keywords detail which includes top search keyword and total search appearances for all the apps from the specified partner. \n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get Search Keywords (By App)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/addons/:addonKey/reporting/search-keywords", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query. Should be in the format **YYYY-MM-DD**." }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query. Should be of the format **YYYY-MM-DD**." }, { "key": "aggregation", "value": "{{aggregation}}", "disabled": true, "description": "The time aggregation. Default value for this is week. For example: week" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner.", "disabled": false }, { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for the app.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch the details of searched keywords for which the particular app showed up. It also populates the leading searched keywords based on the number of counts that resulted in showing the app.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Export Search Keywords (By App)", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/addons/:addonKey/reporting/search-keywords/export", "query": [ { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query. Should be in the format **YYYY-MM-DD**." }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query. Should be of the format **YYYY-MM-DD**." }, { "key": "aggregation", "value": "{{aggregation}}", "disabled": true, "description": "The time aggregation. Default value for this is week. For example: week" }, { "key": "accept", "value": "{{accept}}", "disabled": true, "description": "Specifies the response format. If unspecified, the 'Accept' header will be used." } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner.", "disabled": false }, { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this partner.", "disabled": false } ] }, "method": "GET", "header": [], "description": "Export the list of searched keywords for which the particular app showed up. It also populates the leading searched keywords based on the number of counts that resulted in showing the app.\n\n This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get App requests and approvals", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/reporting/app-requests-and-approvals", "query": [ { "key": "addon", "value": "{{addon}}", "disabled": true, "description": "If specified, restricts the query to values for apps with the specified keys" }, { "key": "startDate", "value": "{{startDate}}", "disabled": true, "description": "Starting date for the query and should be in the format **YYYY-MM-DD** and startDate will always be the start of the month irrespective of the data you provide.\n\n For example: If startDate entered is 2022-01-22, it will reflect as 2022-01-01" }, { "key": "endDate", "value": "{{endDate}}", "disabled": true, "description": "Ending date for the query and should be in the format **YYYY-MM-DD** and endDate will always be the start of the month irrespective of the data you provide.\n\n For example: If endDate entered is 2022-01-22, it will reflect as 2022-01-01" } ], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "To fetch count of app install requests sent by end-users to admins, count of approvals and approval rate.\n\n This resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Fetch metric time series", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/partner-metrics", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this partner.", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "This resource fetches the time series data for the metric of choice. \nIt requires authentication and is currently available as part of EAP.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] }, { "name": "Reviews", "description": "Information about app reviews", "item": [ { "name": "Get app reviews", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews", "query": [ { "key": "sort", "value": "{{sort}}", "disabled": true, "description": "Specifies the review sort order" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" }, { "key": "hosting", "value": "{{hosting}}", "disabled": true, "description": "Only returns apps with the specified hosting model" } ], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of reviews for the specified app." }, "response": [] }, { "name": "Create / update app review", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create or update a specific app review.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get app review", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app review." }, "response": [] }, { "name": "Create / update app review", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create or update a specific app review.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete app review", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete a specific app review." }, "response": [] }, { "name": "Get app review downvote", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId/down", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns whether or not the current user has downvoted the specified app review.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update app review downvote", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId/down", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Updates whether or not the current user has downvoted the specified app review.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get app review flag", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId/flag", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns whether or not the current user has flagged the specified app review.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update app review flag", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId/flag", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Updates whether or not the current user has flagged the specified app review.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get app review response", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId/response", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the response for the specified app review." }, "response": [] }, { "name": "Create / update app review response", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId/response", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create or update a specific app review response.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete app review response", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId/response", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete a specific app review response.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Get app review upvote", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId/up", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns whether or not the current user has upvoted the specified app review.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update app review upvote", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/id/:reviewId/up", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false }, { "key": "reviewId", "value": "{{reviewId}}", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Updates whether or not the current user has upvoted the specified app review.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get my app review", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/mine", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific app review written by the current user.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create / update my app review", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/mine", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create or update a specific app review written by the current user.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete my app review", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}addons/:addonKey/reviews/mine", "query": [], "variable": [ { "key": "addonKey", "value": "{{addonKey}}", "description": "The unique identifier for this app, for example \"com.atlassian.confluence.plugins.confluence-questions\"", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Delete a specific app review written by the current user.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] } ] }, { "name": "Vendors", "description": "Information about vendors", "item": [ { "name": "Get vendors", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors", "query": [ { "key": "excludeAtlassian", "value": "{{excludeAtlassian}}", "disabled": true, "description": "Exclude vendors associated with Atlassian" }, { "key": "forThisUser", "value": "{{forThisUser}}", "disabled": true, "description": "Only returns vendors associated with the current user" }, { "key": "text", "value": "{{text}}", "disabled": true, "description": "Only returns vendors with names that matches the search text" }, { "key": "offset", "value": "{{offset}}", "disabled": true, "description": "If specified, skips ahead by this number of items" }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "If specified, limits the result set to this number of items" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of vendors matching the specified parameters." }, "response": [] }, { "name": "Create vendor", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new vendor.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get vendor", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific vendor." }, "response": [] }, { "name": "Update vendor", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json-patch+json" } ], "description": "Update a specific vendor.\n\nThe request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw" } }, "response": [] }, { "name": "Get vendor contacts", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/contacts", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a list of contacts for the specified vendor." }, "response": [] }, { "name": "Add vendor contact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/contacts", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Adds a user as a contact associated with a specific vendor. The `username` property in the request body must match a user who already has an account on Marketplace.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get vendor contact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/contacts/:userId", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "userId", "value": "{{userId}}", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get a specific contact for the specified vendor.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Delete vendor contact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/contacts/:userId", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "userId", "value": "{{userId}}", "disabled": false } ] }, "method": "DELETE", "header": [], "description": "Removes the user from the vendor's list of contacts. This resource does *not* remove the user's Marketplace account.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Update vendor contact", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/contacts/:userId", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false }, { "key": "userId", "value": "{{userId}}", "disabled": false } ] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json-patch+json" } ], "description": "Updates the permissions a particular user has in association with a particular vendor.\n\nThe request body must be a valid JSON Patch document. The properties which can be referenced in the PATCH are the same ones returned by a GET on this URI.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw" } }, "response": [] }, { "name": "Get payment details", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/paymentInfo", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the payment details for the specified vendor.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } } }, "response": [] }, { "name": "Create / update payment details", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}vendors/:vendorId/paymentInfo", "query": [], "variable": [ { "key": "vendorId", "value": "{{vendorId}}", "description": "The unique identifier for this vendor", "disabled": false } ] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create or update the payment details for a specific vendor. \n\nAtlassian uses this information to send electronic payments for paid-via-Atlassian app sales. It is only required for vendors who are using the Atlassian payment and licensing system.\n\nThis resource requires authentication.", "auth": { "type": "basic", "basic": { "username": "{{username}}", "password": "{{apiToken}}" } }, "body": { "mode": "raw", "raw": "" } }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "https" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "marketplace.atlassian.com" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "rest/2/" } ] }