ad_account_id, filtered by the specified options.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
@@ -424,8 +424,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ad_groups/targeting_analytics':
get:
- operationId: ad_groups_targeting_analytics/get
summary: Get targeting analytics for ad groups
+ operationId: getTargetingAnalyticsForAdGroups
description: |-
Get targeting analytics for one or more ad groups.
For the requested ad group(s) and metrics, the response will include the requested metric information
@@ -473,8 +473,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ad_groups/audience_sizing':
post:
- operationId: ad_groups/audience_sizing
summary: Get audience sizing
+ operationId: getAudienceSizing
description: |-
Get potential audience size for an ad group with given targeting criteria.
Potential audience size estimates the number of people you may be able to reach per month with your campaign.
@@ -530,8 +530,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ad_groups/{ad_group_id}':
get:
- operationId: ad_groups/get
summary: Get ad group
+ operationId: getAdGroup
description: Get a specific ad group given the ad group ID.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -560,8 +560,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ad_previews':
post:
- operationId: ad_previews/create
summary: Create ad preview with pin or image
+ operationId: createAdPreviewWithPinOrImage
description: |-
Create an ad preview given an ad account ID and either an existing organic pin ID or the URL for an image to be used to create the Pin and the ad.
If you are creating a preview from an existing Pin, that Pin must be promotable: that is, it must have a clickthrough link and meet other requirements. (See Ads Overview.)
@@ -610,8 +610,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ads':
get:
- operationId: ads/list
summary: List ads
+ operationId: listAds
description: |-
List ads that meet the filters provided:
- Listed campaign ids or ad group ids or ad ids
@@ -669,8 +669,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: enabled
post:
- operationId: ads/create
summary: Create ads
+ operationId: createAds
description: 'Create multiple new ads. Request must contain `ad_group_id`, `creative_type`, and the source Pin `pin_id`.'
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -706,8 +706,8 @@ paths:
x-ratelimit-category: ads_write
x-sandbox: enabled
patch:
- operationId: ads/update
summary: Update ads
+ operationId: updateAds
description: Update multiple existing ads
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -744,8 +744,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ads/analytics':
get:
- operationId: ads/analytics
summary: Get ad analytics
+ operationId: getAdAnalytics
description: |-
Get analytics for the specified ads in the specified ad_account_id, filtered by the specified options.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
@@ -809,8 +809,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ads_credit/discounts':
get:
- operationId: ads_credits_discounts/get
summary: Get ads credit discounts
+ operationId: getAdsCreditDiscounts
description: |-
Returns the list of discounts applied to the account.
@@ -849,8 +849,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/ads_credit/redeem':
post:
- operationId: ads_credit/redeem
summary: Redeem ad credits
+ operationId: redeemAdCredits
description: |-
Redeem ads credit on behalf of the ad account id and apply it towards billing.
@@ -898,8 +898,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/ads/targeting_analytics':
get:
- operationId: ad_targeting_analytics/get
summary: Get targeting analytics for ads
+ operationId: getTargetingAnalyticsForAds
description: |-
Get targeting analytics for one or more ads. For the requested ad(s) and metrics,
the response will include the requested metric information (e.g. SPEND_IN_DOLLAR) for the requested target type
@@ -947,8 +947,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ads/{ad_id}':
get:
- operationId: ads/get
summary: Get ad
+ operationId: getAd
description: |-
Get a specific ad given the ad ID. If your pin is rejected, rejected_reasons will
contain additional information from the Ad Review process.
@@ -980,8 +980,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/advertiser_defined_events':
get:
- operationId: advertiser_defined_events/get
summary: Get advertiser defined events
+ operationId: getAdvertiserDefinedEvents
description: Get advertiser defined events for the given ad account.
parameters: - $ref: '#/components/parameters/path_ad_account_id' @@ -1061,8 +1061,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/analytics': get: - operationId: ad_account/analytics summary: Get ad account analytics + operationId: getAdAccountAnalytics description: |- Get analytics for the specifiedad_account_id, filtered by the specified options.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
@@ -1112,8 +1112,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/audience_insights':
get:
- operationId: audience_insights/get
summary: Get audience insights
+ operationId: getAudienceInsights
description: |-
Get Audience Insights for an ad account. The response will return insights for 3 types of audiences: the
ad account's engaged audience on Pinterest, the ad account's total audience on Pinterest and Pinterest's
@@ -1146,8 +1146,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/audiences':
get:
- operationId: audiences/list
summary: List audiences
+ operationId: listAudiences
description: Get list of audiences for the ad account.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -1216,8 +1216,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: disabled
post:
- operationId: audiences/create
summary: Create audience
+ operationId: createAudience
description: |-
Create an audience you can use in targeting for specific ad groups. Targeting combines customer information with
the ways users interact with Pinterest to help you reach specific groups of users; you can include or exclude
@@ -1254,8 +1254,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/audiences/{audience_id}':
get:
- operationId: audiences/get
summary: Get audience
+ operationId: getAudience
description: Get a specific audience given the audience ID.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -1289,8 +1289,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: disabled
patch:
- operationId: audiences/update
summary: Update audience
+ operationId: updateAudience
description: Update (edit or remove) an existing targeting audience.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -1324,8 +1324,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/audiences/shared/accounts':
get:
- operationId: ad_accounts_audiences_shared_accounts/list
summary: List accounts with access to an audience owned by an ad account
+ operationId: listAccountsWithAccessToAnAudienceOwnedByAnAdAccount
description: List all ad accounts and/or businesses that have access to a specific audience. The audience must be owned by the requesting ad account.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -1381,6 +1381,7 @@ paths:
patch:
operationId: update_ad_account_to_ad_account_shared_audience
summary: Update audience sharing between ad accounts
+ operationId: updateAudienceSharingBetweenAdAccounts
description: 'From an ad account, share a specific audience with another ad account, or revoke access to a previously shared audience. Only the audience owner account can share the audience. The recipient ad account(s) must be in the same Pinterest Business Hierarchy as the business owner of the ad account.Microcurrency is used to track very small transactions, based on the currency set in the advertiser’s profile.
@@ -1513,8 +1515,8 @@ paths: x-sandbox: enabled '/ad_accounts/{ad_account_id}/billing_profiles': get: - operationId: billing_profiles/get summary: Get billing profiles + operationId: getBillingProfiles description: |- Get billing profiles in the advertiser account. @@ -1559,8 +1561,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/billing_invoices': get: - operationId: billing_invoices/get summary: Get billing invoices + operationId: getBillingInvoices description: Get billing invoices in the advertiser account. parameters: - $ref: '#/components/parameters/path_ad_account_id' @@ -1611,8 +1613,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/billing_invoice/{billing_invoice_id}/download': get: - operationId: billing_invoice_download/get summary: Get download url for a billing invoice + operationId: getDownloadUrlForABillingInvoice description: Get download url for a billing invoice. parameters: - $ref: '#/components/parameters/path_ad_account_id' @@ -1649,8 +1651,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/bulk/download': post: - operationId: bulk_download/create summary: Get advertiser entities in bulk + operationId: getAdvertiserEntitiesInBulk description: |- Create an asynchronous report that may include information on campaigns, ad groups, product groups, ads, keywords, and/or labels; can filter by campaigns. Though the entities may be active, archived, or paused, @@ -1686,8 +1688,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/bulk/upsert': post: - operationId: bulk_upsert/create summary: Create/update ad entities in bulk + operationId: createUpdateAdEntitiesInBulk description: |- Either create or update any combination of campaigns, ad groups, product groups, ads, keywords, or labels. Note that this request will be processed asynchronously; the response will include arequest_id
@@ -1723,8 +1725,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/bulk/{bulk_request_id}':
get:
- operationId: bulk_request/get
summary: Download advertiser entities in bulk
+ operationId: downloadAdvertiserEntitiesInBulk
description: |-
Get the status of a bulk request by request_id, along with a download URL that will allow you to download the
new or updated entity data (campaigns, ad groups, product groups, ads, or keywords).
@@ -1756,8 +1758,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/campaigns':
get:
- operationId: campaigns/list
summary: List campaigns
+ operationId: listCampaigns
description: |-
Get a list of the campaigns in the specified ad_account_id, filtered by the specified options.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
@@ -1807,8 +1809,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: enabled
post:
- operationId: campaigns/create
summary: Create campaigns
+ operationId: createCampaigns
description: |-
Create multiple new campaigns. Every campaign has its own campaign_id and houses one or more ad groups, which contain one or more ads.
For more, see Set up your campaign.
@@ -1860,8 +1862,8 @@ paths:
x-ratelimit-category: ads_write
x-sandbox: enabled
patch:
- operationId: campaigns/update
summary: Update campaigns
+ operationId: updateCampaigns
description: |-
Update multiple ad campaigns based on campaign_ids.
Note:
@@ -1913,8 +1915,8 @@ paths: x-sandbox: enabled '/ad_accounts/{ad_account_id}/campaigns/analytics': get: - operationId: campaigns/analytics summary: Get campaign analytics + operationId: getCampaignAnalytics description: |- Get analytics for the specified campaigns in the specifiedad_account_id, filtered by the specified options.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
@@ -1966,8 +1968,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/campaigns/targeting_analytics':
get:
- operationId: campaign_targeting_analytics/get
summary: Get targeting analytics for campaigns
+ operationId: getTargetingAnalyticsForCampaigns
description: |-
Get targeting analytics for one or more campaigns.
For the requested account and metrics, the response will include the requested metric information
@@ -2015,8 +2017,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/campaigns/{campaign_id}':
get:
- operationId: campaigns/get
summary: Get campaign
+ operationId: getCampaign
description: Get a specific campaign given the campaign ID.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -2045,8 +2047,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/conversion_tags':
post:
- operationId: conversion_tags/create
summary: Create conversion tag
+ operationId: createConversionTag
description: |-
Create a conversion tag, also known as [Pinterest tag](https://help.pinterest.com/en/business/article/set-up-the-pinterest-tag), with the option to enable enhanced match.
@@ -2124,8 +2126,8 @@ paths:
x-ratelimit-category: ads_write
x-sandbox: disabled
get:
- operationId: conversion_tags/list
summary: List conversion tags
+ operationId: listConversionTags
description: List conversion tags associated with an ad account.
parameters:
- $ref: '#/components/parameters/query_filter_deleted'
@@ -2191,8 +2193,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/conversion_tags/ocpm_eligible':
get:
- operationId: ocpm_eligible_conversion_tags/get
summary: Get Ocpm eligible conversion tags
+ operationId: getOcpmEligibleConversionTags
description: Get Ocpm eligible conversion tag events for an ad account.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -2220,8 +2222,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/conversion_tags/page_visit':
get:
- operationId: page_visit_conversion_tags/get
summary: Get page visit conversion tags
+ operationId: getPageVisitConversionTags
description: Get all page visit conversion tag events for an ad account.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -2259,8 +2261,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/conversion_tags/{conversion_tag_id}':
get:
- operationId: conversion_tags/get
summary: Get conversion tag
+ operationId: getConversionTag
description: Get information about an existing conversion tag.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -2289,8 +2291,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/customer_lists':
post:
- operationId: customer_lists/create
summary: Create customer lists
+ operationId: createCustomerLists
description: |-
Create a customer list from your records(hashed or plain-text email addresses, or hashed MAIDs or IDFAs).
A customer list is one of the four types of Pinterest audiences: for more information, see Audience targeting @@ -2331,8 +2333,8 @@ paths: x-ratelimit-category: ads_write x-sandbox: disabled get: - operationId: customer_lists/list summary: Get customer lists + operationId: getCustomerLists description: |-
Get a set of customer lists including id and name based on the filters provided.
(Customer lists are a type of audience.) For more information, see @@ -2373,8 +2375,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/customer_lists/{customer_list_id}': get: - operationId: customer_lists/get summary: Get customer list + operationId: getCustomerList description: Gets a specific customer list given the customer list ID. parameters: - $ref: '#/components/parameters/path_ad_account_id' @@ -2402,8 +2404,8 @@ paths: x-ratelimit-category: ads_read x-sandbox: disabled patch: - operationId: customer_lists/update summary: Update customer list + operationId: updateCustomerList description: |-
Append or remove records to/from an existing customer list. (A customer list is one of the four types of Pinterest audiences.)
When you add records to an existing customer list, the system scans the additions for existing Pinterest @@ -2443,8 +2445,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/customer_lists/{customer_list_id}/uploads': post: - operationId: customer_list_uploads/create summary: Create customer list upload + operationId: createCustomerListUpload description: |- Closed beta @@ -2484,8 +2486,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/customer_lists/{customer_list_id}/uploads/{customer_list_upload_id}': get: - operationId: customer_list_uploads/get summary: Get customer list upload + operationId: getCustomerListUpload description: |- Closed beta
Get the metadata for a given upload by its ID.
@@ -2515,8 +2517,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/customer_lists/{customer_list_id}/uploads/{customer_list_upload_id}/run': post: - operationId: customer_list_uploads/run summary: Run customer list upload + operationId: runCustomerListUpload description: |- Closed betaBegin processing a customer list upload.
@@ -2546,8 +2548,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/events': post: - operationId: events/create summary: Send conversions + operationId: sendConversions description: |- The Pinterest API offers advertisers a way to send Pinterest their conversion information (including web conversions, in-app conversions, or even offline conversions) based on theirad_account_id. The request body should be a JSON object.
- This endpoint requires an access_token be generated through Ads Manager. Review the Conversions Guide for more details. (Note that the authorization header required is Authorization: Bearer <access_token>).
@@ -2653,8 +2655,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/msot/events':
post:
- operationId: msot_events/create
summary: Send Measurement Source Of Truth (MSOT) attributed conversion events
+ operationId: sendMeasurementSourceOfTruthMsotAttributedConversionEvents
description: |-
This feature is currently in beta and not available to all apps, if you're interested in joining the beta, please reach out to your Pinterest account manager.
Get a list of keywords based on the filters provided. If no filter is provided, it will default to the ad_account_id filter, which means it will only return keywords that specifically have parent_id set to the ad_account_id. Note: Keywords can have ad_account_ids, campaign_ids, and ad_group_ids set as their parent_ids. Keywords created through Ads Manager will have their parent_id set to an ad_group_id, not ad_account_id.
For more information, see Keyword targeting.
@@ -2808,8 +2810,8 @@ paths: x-ratelimit-category: ads_read x-sandbox: enabled post: - operationId: keywords/create summary: Create keywords + operationId: createKeywords description: |-Create keywords for following entity types(advertiser, campaign, ad group or ad).
For more information, see Keyword targeting.
Notes:
For more information on match types, see match type enums.
@@ -2844,8 +2846,8 @@ paths: x-ratelimit-category: ads_write x-sandbox: enabled patch: - operationId: keywords/update summary: Update keywords + operationId: updateKeywords description:Update one or more keywords' bid and archived fields.
Archiving a keyword effectively deletes it - keywords no longer receive metrics and no longer visible within the parent entity's keywords list.
parameters: - $ref: '#/components/parameters/path_ad_account_id' @@ -2877,8 +2879,8 @@ paths: x-sandbox: enabled '/ad_accounts/{ad_account_id}/keywords/metrics': get: - operationId: country_keywords_metrics/get summary: Get country's keyword metrics + operationId: getCountrySKeywordMetrics description: |- See keyword metrics for a specified country, aggregated across all of Pinterest. (Definitions are available from the "Get delivery metrics definitions" @@ -2911,8 +2913,8 @@ paths: x-sandbox: enabled '/ad_accounts/{ad_account_id}/labels': post: - operationId: labels/create summary: Create labels + operationId: createLabels description: |-Closed beta @@ -2953,8 +2955,8 @@ paths: x-ratelimit-category: ads_write x-sandbox: enabled get: - operationId: labels/list summary: List labels + operationId: listLabels description: |-
Closed beta @@ -3008,8 +3010,8 @@ paths: x-ratelimit-category: ads_read x-sandbox: enabled patch: - operationId: labels/update summary: Update labels + operationId: updateLabels description: |-
Closed beta
@@ -3048,8 +3050,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/lead_forms':
get:
- operationId: lead_forms/list
summary: List lead forms
+ operationId: listLeadForms
description: |-
This feature is currently in beta and not available to all apps, if you're interested in joining the beta, please reach out to your Pinterest account manager.
@@ -3098,8 +3100,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: enabled
post:
- operationId: lead_forms/create
summary: Create lead forms
+ operationId: createLeadForms
description: |-
This feature is currently in beta and not available to all apps, if you're interested in joining the beta, please reach out to your Pinterest account manager.
@@ -3149,8 +3151,8 @@ paths:
x-ratelimit-category: ads_write
x-sandbox: disabled
patch:
- operationId: lead_forms/update
summary: Update lead forms
+ operationId: updateLeadForms
description: |-
This feature is currently in beta and not available to all apps, if you're interested in joining the beta, please reach out to your Pinterest account manager.
@@ -3201,8 +3203,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/lead_forms/{lead_form_id}':
get:
- operationId: lead_form/get
summary: Get lead form by id
+ operationId: getLeadFormById
description: |-
This feature is currently in beta and not available to all apps, if you're interested in joining the beta, please reach out to your Pinterest account manager.
@@ -3252,8 +3254,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/lead_forms/{lead_form_id}/test':
post:
- operationId: lead_form_test/create
summary: Create lead form test data
+ operationId: createLeadFormTestData
description: |-
Create lead form test data based on the list of answers provided as part of the body.
- List of answers should follow the questions creation order.
@@ -3307,8 +3309,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/leads/subscriptions':
get:
- operationId: ad_accounts_subscriptions/get_list
summary: Get lead ads subscriptions
+ operationId: getLeadAdsSubscriptions
description: Get the advertiser's list of lead ads subscriptions. Only requests for the OWNER or ADMIN of the ad_account will be allowed.
parameters:
- $ref: '#/components/parameters/Pinterest.Lib.AdAccountId'
@@ -3375,8 +3377,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: disabled
post:
- operationId: ad_accounts_subscriptions/post
summary: Create lead ads subscription
+ operationId: createLeadAdsSubscription
description: |-
Create a lead ads webhook subscription.
Subscriptions allow Pinterest to deliver lead data from Ads Manager directly to the subscriber. Subscriptions can exist for a specific lead form or at ad account level.
@@ -3425,8 +3427,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/leads/subscriptions/{subscription_id}':
get:
- operationId: ad_accounts_subscriptions/get_by_id
summary: Get lead ads subscription by ID
+ operationId: getLeadAdsSubscriptionById
description: |-
Get an existing lead ads webhook subscription by ID.
- Only requests for the OWNER or ADMIN of the ad_account will be allowed.'
@@ -3486,8 +3488,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: disabled
delete:
- operationId: ad_accounts_subscriptions/del_by_id
summary: Delete lead ads subscription
+ operationId: deleteLeadAdsSubscription
description: |-
Delete an existing lead ads webhook subscription by ID.
- Only requests for the OWNER or ADMIN of the ad_account will be allowed.'
@@ -3542,8 +3544,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/leads_export':
post:
- operationId: leads_export/create
summary: Create a request to export leads collected from a lead ad
+ operationId: createARequestToExportLeadsCollectedFromALeadAd
description: |-
This feature is currently in beta and not available to all apps, if you're interested in joining the beta, please reach out to your Pinterest account manager.
@@ -3591,8 +3593,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/leads_export/{leads_export_id}':
get:
- operationId: leads_export/get
summary: Get the lead export from the lead export create call
+ operationId: getTheLeadExportFromTheLeadExportCreateCall
description: |-
This feature is currently in beta and not available to all apps, if you're interested in joining the beta, please reach out to your Pinterest account manager.
@@ -3651,8 +3653,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/mmm_reports':
get:
- operationId: analytics/get_mmm_report
summary: Get advertiser Marketing Mix Modeling (MMM) report.
+ operationId: getAdvertiserMarketingMixModelingMmmReport
description: |-
Get an mmm report for an ad account. This returns a URL to an mmm metrics report given a token returned from the
create mmm report endpoint.
@@ -3689,8 +3691,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: disabled
post:
- operationId: analytics/create_mmm_report
summary: Create a request for a Marketing Mix Modeling (MMM) report
+ operationId: createARequestForAMarketingMixModelingMmmReport
description: |-
This creates an asynchronous mmm report based on the given request. It returns a token that you can use to download
the report when it is ready. NOTE: An additional limit of 5 queries per minute per advertiser applies to this endpoint while it's in beta release.
@@ -3733,8 +3735,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/order_lines':
get:
- operationId: order_lines/list
summary: Get order lines
+ operationId: getOrderLines
description: List existing order lines associated with an ad account.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -3770,8 +3772,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/order_lines/{order_line_id}':
get:
- operationId: order_lines/get
summary: Get order line
+ operationId: getOrderLine
description: Get a specific existing order line associated with an ad account.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -3798,8 +3800,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/pins/analytics':
get:
- operationId: ad_pins/analytics
summary: Get pins analytics
+ operationId: getPinsAnalytics
description: |-
Get analytics for the pins given a campaign and pins in the specified ad_account_id, filtered by the specified options.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
@@ -3850,8 +3852,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/product_group_promotions':
post:
- operationId: product_group_promotions/create
summary: Create product group promotions
+ operationId: createProductGroupPromotions
description: Add one or more product groups from your catalog to an existing ad group. (Product groups added to an ad group are a 'product group promotion.')
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -3883,8 +3885,8 @@ paths:
x-ratelimit-category: ads_write
x-sandbox: disabled
patch:
- operationId: product_group_promotions/update
summary: Update product group promotions
+ operationId: updateProductGroupPromotions
description: Update multiple existing Product Group Promotions (by product_group_id)
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -3916,8 +3918,8 @@ paths:
x-ratelimit-category: ads_write
x-sandbox: disabled
get:
- operationId: product_group_promotions/list
summary: Get product group promotions
+ operationId: getProductGroupPromotions
description: |-
List existing product group promotions associated with an ad account.
@@ -3962,8 +3964,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/product_group_promotions/{product_group_promotion_id}':
get:
- operationId: product_group_promotions/get
summary: Get a product group promotion by id
+ operationId: getAProductGroupPromotionById
description: Get a product group promotion by id
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -3990,8 +3992,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/product_groups/analytics':
get:
- operationId: product_groups/analytics
summary: Get product group analytics
+ operationId: getProductGroupAnalytics
description: |-
Get analytics for the specified product groups in the specified ad_account_id, filtered by the specified options.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
@@ -4042,8 +4044,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/promotions':
get:
- operationId: promotions/list
summary: Get promotions
+ operationId: getPromotions
description: Gets all promotions associated with an ad account ID that can be applied to an ad group. Can be either internally-saved promotions or external promotions imported from a commerce integration.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -4086,8 +4088,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: disabled
post:
- operationId: promotions/create
summary: Create promotions
+ operationId: createPromotions
description: Create multiple new promotions.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -4133,8 +4135,8 @@ paths:
x-ratelimit-category: ads_write
x-sandbox: disabled
patch:
- operationId: promotions/update
summary: Update promotions
+ operationId: updatePromotions
description: Update multiple promotions.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -4181,8 +4183,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/promotions/{promotion_id}':
get:
- operationId: promotions/get
summary: Get promotion by id
+ operationId: getPromotionById
description: Get a promotion by its Pinterest-specific id. It must be associated with the provided ad account id.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -4217,8 +4219,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: disabled
delete:
- operationId: promotions/delete
summary: Delete promotion by id
+ operationId: deletePromotionById
description: Delete a promotion within Pinterest.
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -4241,8 +4243,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/reports':
get:
- operationId: analytics/get_report
summary: Get the account analytics report created by the async call
+ operationId: getTheAccountAnalyticsReportCreatedByTheAsyncCall
description: |-
This returns a URL to an analytics report given a token returned from the post request report creation call. You can use the URL to download the report. The link is valid for five minutes and the report is valid for one hour.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
@@ -4279,8 +4281,8 @@ paths:
x-ratelimit-category: ads_analytics
x-sandbox: disabled
post:
- operationId: analytics/create_report
summary: Create async request for an account analytics report
+ operationId: createAsyncRequestForAnAccountAnalyticsReport
description: |-
This returns a token that you can use to download the report when it is ready. Note that this endpoint requires the parameters to be passed as JSON-formatted in the request body. This endpoint does not support URL query parameters.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Analyst, Campaign Manager.
@@ -4327,8 +4329,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/reports/brand_category_sku':
get:
- operationId: analytics/get_conversion_product_report
summary: 'Get advertiser brand, category, SKU report'
+ operationId: getAdvertiserBrandCategorySkuReport
description: |-
Restricted
Get a brand, category, SKU report for an ad account. This call returns the URL for the report that matches the token returned in the request to the Create brand, category, SKU report endpoint.
@@ -4365,8 +4367,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: disabled
post:
- operationId: analytics/create_conversion_product_report
summary: 'Create a request for a brand, category, SKU report'
+ operationId: createARequestForABrandCategorySkuReport
description: |-
Restricted
This creates an asynchronous brand, category, SKU report based on the given request. This request returns a token that you can use to download the report when it is ready.
@@ -4409,8 +4411,8 @@ paths:
x-sandbox: disabled
'/ad_accounts/{ad_account_id}/sandbox':
delete:
- operationId: sandbox/delete
summary: Delete ads data for ad account in API Sandbox
+ operationId: deleteAdsDataForAdAccountInApiSandbox
description: |-
Delete an ad account and all the ads data associated with that account.
A string message is returned indicating the status of the delete operation.
@@ -4451,8 +4453,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ssio/accounts':
get:
- operationId: ssio_accounts/get
summary: Get Salesforce account details including bill-to information.
+ operationId: getSalesforceAccountDetailsIncludingBillToInformation
description: |-
Get Salesforce account details including bill-to information to be used in insertion orders process for ad_account_id.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.
@@ -4489,8 +4491,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ssio/insertion_orders':
post:
- operationId: ssio_insertion_order/create
summary: Create insertion order through SSIO.
+ operationId: createInsertionOrderThroughSsio
description: |-
Create insertion order through SSIO for ad_account_id.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.
@@ -4533,8 +4535,8 @@ paths:
x-ratelimit-category: ads_write
x-sandbox: enabled
patch:
- operationId: ssio_insertion_order/edit
summary: Edit insertion order through SSIO.
+ operationId: editInsertionOrderThroughSsio
description: |-
Edit insertion order through SSIO for ad_account_id.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.
@@ -4578,8 +4580,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ssio/insertion_orders/status':
get:
- operationId: ssio_insertion_orders_status/get_by_ad_account
summary: Get insertion order status by ad account id.
+ operationId: getInsertionOrderStatusByAdAccountId
description: |-
Get insertion order status for account id ad_account_id.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.
@@ -4625,8 +4627,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ssio/insertion_orders/{pin_order_id}/status':
get:
- operationId: ssio_insertion_orders_status/get_by_pin_order_id
summary: Get insertion order status by pin order id.
+ operationId: getInsertionOrderStatusByPinOrderId
description: |-
Get insertion order status for pin order id pin_order_id.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.
@@ -4664,8 +4666,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/ssio/order_lines':
get:
- operationId: ssio_order_lines/get_by_ad_account
summary: Get Salesforce order lines by ad account id.
+ operationId: getSalesforceOrderLinesByAdAccountId
description: |-
Get Salesforce order lines for account id ad_account_id.
- The token's user_account must either be the Owner of the specified ad account, or have one of the necessary roles granted to them via Business Access: Admin, Finance, Campaign.
@@ -4712,8 +4714,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/targeting_analytics':
get:
- operationId: ad_account_targeting_analytics/get
summary: Get targeting analytics for an ad account
+ operationId: getTargetingAnalyticsForAnAdAccount
description: |-
Get targeting analytics for an ad account.
For the requested account and metrics, the response will include the requested metric information
@@ -4760,8 +4762,8 @@ paths:
x-sandbox: enabled
'/ad_accounts/{ad_account_id}/targeting_templates':
get:
- operationId: targeting_template/list
summary: List targeting templates
+ operationId: listTargetingTemplates
description: Get a list of the targeting templates in the specified ad_account_id
parameters:
- $ref: '#/components/parameters/path_ad_account_id'
@@ -4821,8 +4823,8 @@ paths:
x-ratelimit-category: ads_read
x-sandbox: disabled
post:
- operationId: targeting_template/create
summary: Create targeting templates
+ operationId: createTargetingTemplates
description: |-
Targeting templates allow advertisers to save a set of targeting details including audience lists, keywords & interest, demographics, and placements to use more than once during the campaign creation process.
@@ -4867,8 +4869,8 @@ paths: x-ratelimit-category: ads_write x-sandbox: disabled patch: - operationId: targeting_template/update summary: Update targeting templates + operationId: updateTargetingTemplates description:Update the targeting template given advertiser ID and targeting template ID
parameters: - $ref: '#/components/parameters/path_ad_account_id' @@ -4906,8 +4908,8 @@ paths: x-sandbox: enabled '/ad_accounts/{ad_account_id}/templates': get: - operationId: templates/list summary: List templates + operationId: listTemplates description: Gets all Templates associated with an ad account ID. parameters: - $ref: '#/components/parameters/path_ad_account_id' @@ -4952,8 +4954,8 @@ paths: x-sandbox: enabled '/ad_accounts/{ad_account_id}/templates/{template_id}/reports': post: - operationId: analytics/create_template_report summary: Create async request for an analytics report using a template + operationId: createAsyncRequestForAnAnalyticsReportUsingATemplate description: |2- @@ -5024,8 +5026,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/terms_of_service': get: - operationId: terms_of_service/get summary: Get terms of service + operationId: getTermsOfService description: Get the text of the terms of service and see whether the advertiser has accepted the terms of service. parameters: - $ref: '#/components/parameters/path_ad_account_id' @@ -5053,8 +5055,8 @@ paths: x-sandbox: enabled /advanced_auction/items/get: post: - operationId: advanced_auction_items_get/post summary: Get item bid options (POST) + operationId: getItemBidOptionsPost description: |- Get the bid options for a batch of retail catalog items. @@ -5129,8 +5131,8 @@ paths: x-sandbox: enabled /advanced_auction/items/submit: post: - operationId: advanced_auction_items_submit/post summary: Operate on item level bid options + operationId: operateOnItemLevelBidOptions description: |- This endpoint supports multiple operations on a set of one or more bid options (bid price and bid adjustments for targeting categories) for retail catalog items. These advanced auction settings are applied in campaigns using objective_type `CATALOG_SALES` and ad groups using bid_strategy_type `MAX_BID`. @@ -5211,8 +5213,8 @@ paths: x-sandbox: enabled /boards: post: - operationId: boards/create summary: Create board + operationId: createBoard description: |- Create a board owned by the "operation user_account". Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". @@ -5286,8 +5288,8 @@ paths: x-ratelimit-category: org_write x-sandbox: enabled get: - operationId: boards/list summary: List boards + operationId: listBoards description: |- Get a list of the boards owned by the "operation user_account" + group boards where this account is a collaborator Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". @@ -5362,8 +5364,8 @@ paths: x-sandbox: enabled '/boards/{board_id}': get: - operationId: boards/get summary: Get board + operationId: getBoard description: |- Get a board owned by the operation user_account - or a group board that has been shared with this account. * Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". @@ -5424,8 +5426,8 @@ paths: x-ratelimit-category: org_read x-sandbox: enabled delete: - operationId: boards/delete summary: Delete board + operationId: deleteBoard description: |- Delete a board owned by the "operation user_account". * Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". @@ -5481,8 +5483,8 @@ paths: x-ratelimit-category: org_write x-sandbox: enabled patch: - operationId: boards/update summary: Update board + operationId: updateBoard description: |- Update a board owned by the "operating user_account". * Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". @@ -5552,8 +5554,8 @@ paths: x-sandbox: enabled '/boards/{board_id}/pins': get: - operationId: boards/list_pins summary: List Pins on board + operationId: listPinsOnBoard description: |- Get a list of the Pins on a board owned by the "operation user_account" - or on a group board that has been shared with this account. - Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". @@ -5607,8 +5609,8 @@ paths: x-sandbox: enabled '/boards/{board_id}/sections': get: - operationId: board_sections/list summary: List board sections + operationId: listBoardSections description: |- Get a list of all board sections from a board owned by the "operation user_account" - or a group board that has been shared with this account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". @@ -5648,8 +5650,8 @@ paths: x-ratelimit-category: org_read x-sandbox: enabled post: - operationId: board_sections/create summary: Create board section + operationId: createBoardSection description: |- Create a board section on a board owned by the "operation user_account" - or on a group board that has been shared with this account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". @@ -5723,8 +5725,8 @@ paths: x-sandbox: enabled '/boards/{board_id}/sections/{section_id}': patch: - operationId: board_sections/update summary: Update board section + operationId: updateBoardSection description: |- Update a board section on a board owned by the "operation user_account" - or on a group board that has been shared with this account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". @@ -5789,8 +5791,8 @@ paths: x-ratelimit-category: org_write x-sandbox: enabled delete: - operationId: board_sections/delete summary: Delete board section + operationId: deleteBoardSection description: |- Delete a board section on a board owned by the "operation user_account" - or on a group board that has been shared with this account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". @@ -5845,8 +5847,8 @@ paths: x-sandbox: enabled '/boards/{board_id}/sections/{section_id}/pins': get: - operationId: board_sections/list_pins summary: List Pins on board section + operationId: listPinsOnBoardSection description: |- Get a list of the Pins on a board section of a board owned by the "operation user_account" - or on a group board that has been shared with this account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". @@ -5917,8 +5919,8 @@ paths: x-sandbox: enabled /businesses/employers: get: - operationId: get/business_employers summary: List business employers for user + operationId: listBusinessEmployersForUser description: Get all of the viewing user's business employers. parameters: - $ref: '#/components/parameters/query_page_size' @@ -5955,6 +5957,7 @@ paths: patch: operationId: respond_business_access_invites summary: Accept or decline an invite/request + operationId: acceptOrDeclineAnInviteRequest description: Accept or decline invites or requests. requestBody: required: true @@ -5985,8 +5988,8 @@ paths: x-sandbox: enabled '/businesses/{business_id}/system_users/{system_user_id}': patch: - operationId: system_user/update summary: Update a system user information. + operationId: updateASystemUserInformation description: Update a system user information such as name. parameters: - $ref: '#/components/parameters/path_business_user' @@ -6041,8 +6044,8 @@ paths: x-sandbox: disabled '/businesses/{business_id}/assets/{asset_id}/members': get: - operationId: business_asset_members/get summary: Get members with access to asset + operationId: getMembersWithAccessToAsset description: Get all the members the requesting business has granted access to on the given asset. parameters: - $ref: '#/components/parameters/path_business_user' @@ -6081,8 +6084,8 @@ paths: x-sandbox: disabled '/businesses/{business_id}/assets/{asset_id}/partners': get: - operationId: business_asset_partners/get summary: Get partners with access to asset + operationId: getPartnersWithAccessToAsset description: |- Get all the partners the requesting business has granted access to on the given asset. Note: If the asset has been shared with you, an empty array will be returned. This is because an asset shared with @@ -6125,6 +6128,7 @@ paths: post: operationId: create_asset_invites summary: Update invite/request with an asset permission + operationId: updateInviteRequestWithAnAssetPermission description: |- Assign asset permissions information to an existing invite/request. Can be used to: - Request access to a partner's asset. Note: This is only for when no existing partnership exists. If an existing @@ -6174,8 +6178,8 @@ paths: x-sandbox: disabled '/businesses/{business_id}/requests/assets/access': post: - operationId: asset_access_requests/create summary: Create a request to access an existing partner's assets. + operationId: createARequestToAccessAnExistingPartnerSAssets description: Create a request to access an existing partner's assets with the specified permissions. The request will be sent to the partner for approval. The assets that can be requested are ad accounts and profiles. parameters: - $ref: '#/components/parameters/path_business_user' @@ -6208,8 +6212,8 @@ paths: x-sandbox: disabled '/businesses/{business_id}/members': get: - operationId: get/business_members summary: Get business members + operationId: getBusinessMembers description: |- Get all members of the specified business. The return response will include the member's business_role and assets they have access to if assets_summary=TRUE @@ -6265,8 +6269,8 @@ paths: x-ratelimit-category: ads_read x-sandbox: disabled patch: - operationId: update/business_memberships summary: Update member's business role + operationId: updateMemberSBusinessRole description: Update a member's business role within the business. parameters: - $ref: '#/components/parameters/path_business_id' @@ -6303,6 +6307,7 @@ paths: delete: operationId: delete_business_membership summary: Terminate business memberships + operationId: terminateBusinessMemberships description: Terminate memberships between the specified members and your business. parameters: - $ref: '#/components/parameters/path_business_id' @@ -6336,8 +6341,8 @@ paths: x-sandbox: enabled '/businesses/{business_id}/assets': get: - operationId: business_assets/get summary: List business assets + operationId: listBusinessAssets description: Get all the assets the requesting business has access to. This includes assets the business owns and assets the business has access to through partnerships. parameters: - $ref: '#/components/parameters/path_business_user' @@ -6403,8 +6408,8 @@ paths: x-sandbox: disabled '/businesses/{business_id}/members/{member_id}/assets': get: - operationId: business_member_assets/get summary: Get assets assigned to a member + operationId: getAssetsAssignedToAMember description: |- Get assets on which you assigned asset permissions to the given member. Can be used to: - get all assets, regardless of asset type or @@ -6447,8 +6452,8 @@ paths: x-sandbox: disabled '/businesses/{business_id}/members/assets/access': patch: - operationId: business_members_asset_access/update summary: Assign/Update member asset permissions + operationId: assignUpdateMemberAssetPermissions description: | Grant multiple members access to assets and/or update multiple member's exisiting permissions to an asset. Note: Not all listed permissions are applicable to each asset type. For example, PROFILE_PUBLISHER would not be applicable to an asset of type AD_ACCOUNT. The permission level PROFILE_PUBLISHER is only available to an asset of the type PROFILE. @@ -6482,8 +6487,8 @@ paths: x-ratelimit-category: ads_write x-sandbox: disabled delete: - operationId: business_members_asset_access/delete summary: Delete member access to asset + operationId: deleteMemberAccessToAsset description: Terminate multiple members' access to an asset. parameters: - $ref: '#/components/parameters/path_business_user' @@ -6542,8 +6547,8 @@ paths: x-sandbox: disabled '/businesses/{business_id}/invites': get: - operationId: get/invites summary: Get invites/requests + operationId: getInvitesRequests description: Get the membership/partnership invites and/or requests for the authorized user. parameters: - $ref: '#/components/parameters/path_non_system_business_user' @@ -6583,6 +6588,7 @@ paths: post: operationId: create_membership_or_partnership_invites summary: Create invites or requests + operationId: createInvitesOrRequests description: |- Create batch invites or requests. Can create batch invites or requests as described below. - Invite members to join the business. This would required specifying the following: @@ -6630,6 +6636,7 @@ paths: delete: operationId: cancel_invites_or_requests summary: Cancel invites/requests + operationId: cancelInvitesRequests description: Cancel membership/partnership invites and/or requests. parameters: - $ref: '#/components/parameters/path_non_system_business_user' @@ -6664,6 +6671,7 @@ paths: patch: operationId: update_partner_asset_access_handler_impl summary: Assign/Update partner asset permissions + operationId: assignUpdatePartnerAssetPermissions description: |- Grant multiple partners access to assets and/or update multiple partner's exisiting permissions to an asset. If your partner already had permissions on the asset, they will be overriden with the new permissions you assign to them. @@ -6704,6 +6712,7 @@ paths: delete: operationId: delete_partner_asset_access_handler_impl summary: Delete partner access to asset + operationId: deletePartnerAccessToAsset description: |- Terminate multiple partners' access to an asset. If - partner_type=INTERNAL: You will terminate a partner's asset access to your business assets. @@ -6738,8 +6747,8 @@ paths: x-sandbox: disabled '/businesses/{business_id}/partners/{partner_id}/assets': get: - operationId: business_partner_asset_access/get summary: Get assets assigned to a partner or assets assigned by a partner + operationId: getAssetsAssignedToAPartnerOrAssetsAssignedByAPartner description: |- Can be used to get the business assets your partner has granted you access to or the business assets you have granted your partner access to. If you specify: @@ -6794,8 +6803,8 @@ paths: x-sandbox: disabled '/businesses/{business_id}/partners': get: - operationId: get/business_partners summary: Get business partners + operationId: getBusinessPartners description: |- Get all partners of the specified business. @@ -6849,6 +6858,7 @@ paths: delete: operationId: delete_business_partners summary: Terminate business partnerships + operationId: terminateBusinessPartnerships description: |- Terminate partnerships between the specified partners and your business. Note: You may only batch terminate partners of the same partner type. @@ -6890,8 +6900,8 @@ paths: x-sandbox: disabled '/businesses/{business_id}/audiences': get: - operationId: shared_audiences_for_business/list summary: List received audiences for a business + operationId: listReceivedAudiencesForABusiness description: Get a list of received audiences for the given business. parameters: - $ref: '#/components/parameters/path_business_user' @@ -6936,8 +6946,8 @@ paths: x-sandbox: disabled '/businesses/{business_id}/audiences/shared/accounts': get: - operationId: business_account_audiences_shared_accounts/list summary: List accounts with access to an audience owned by a business + operationId: listAccountsWithAccessToAnAudienceOwnedByABusiness description: |- List all ad accounts and/or businesses that have access to a specific audience. The audience must either be owned by an ad account in the requesting business, or it must have been shared with the requesting business. @@ -6994,6 +7004,7 @@ paths: patch: operationId: update_business_to_ad_account_shared_audience summary: Update audience sharing from a business to ad accounts + operationId: updateAudienceSharingFromABusinessToAdAccounts description: 'From a business, share a specific audience with other ad account(s), or revoke access to a previously shared audience.Get details of a specific interest given interest ID.
Click here for a spreadsheet listing interests and their IDs.
' parameters: - $ref: '#/components/parameters/path_interest_id' @@ -11547,8 +11575,8 @@ paths: x-sandbox: enabled '/resources/targeting/{targeting_type}': get: - operationId: targeting_options/get summary: Get targeting options + operationId: getTargetingOptions description: |-You can use targeting values in ads placement to define your intended audience.
Targeting metrics are organized around targeting specifications.
For more information on ads targeting, see Audience targeting.
Sample return:
[{"36313": "Australia: Moreton Bay - North", "124735": "Canada: North Battleford", "36109": "Australia: Murray", "36108": "Australia: Mid North Coast", "36101": "Australia: Capital Region", "811": "U.S.: Reno", "36103": "Australia: Central West", "36102": "Australia: Central Coast", "36105": "Australia: Far West and Orana", "36104": "Australia: Coffs Harbour - Grafton", "36107": "Australia: Illawarra", "36106": "Australia: Hunter Valley Exc Newcastle", "554017": "New Zealand: Wanganui", "554016": "New Zealand: Marlborough", "554015": "New Zealand: Gisborne", "554014": "New Zealand: Tararua", "554013": "New Zealand: Invercargill", "GR": "Greece", "554011": "New Zealand: Whangarei", "554010": "New Zealand: Far North", "717": "U.S.: Quincy-Hannibal-Keokuk", "716": "U.S.: Baton Rouge",...}]
@@ -11582,8 +11610,8 @@ paths:
x-sandbox: enabled
/search/boards:
get:
- operationId: search_user_boards/get
summary: Search user's boards
+ operationId: searchUserSBoards
description: |-
Search for boards for the "operation user_account". This includes boards of all board types.
- By default, the "operation user_account" is the token user_account.
@@ -11627,8 +11655,8 @@ paths:
x-sandbox: disabled
/search/pins:
get:
- operationId: search_user_pins/list
summary: Search user's Pins
+ operationId: searchUserSPins
description: |-
Search for pins for the "operation user_account".
- By default, the "operation user_account" is the token user_account.
@@ -11683,6 +11711,7 @@ paths:
get:
operationId: search_partner_pins
summary: Search pins by a given search term
+ operationId: searchPinsByAGivenSearchTerm
description: |-
This endpoint is currently in beta and not available to all apps. Learn more.
@@ -11749,8 +11778,8 @@ paths:
x-sandbox: disabled
/terms/related:
get:
- operationId: terms_related/list
summary: List related terms
+ operationId: listRelatedTerms
description: |-
Get a list of terms logically related to each input term.
Example: the term 'workout' would list related terms like 'one song workout', 'yoga workout', 'workout motivation', etc.
@@ -11787,8 +11816,8 @@ paths:
x-sandbox: enabled
/terms/suggested:
get:
- operationId: terms_suggested/list
summary: List suggested terms
+ operationId: listSuggestedTerms
description: |-
Get popular search terms that begin with your input term.
Example: 'sport' would return popular terms like 'sports bar' and 'sportswear', but not 'motor sports' since the phrase does not begin with the given term.
@@ -11826,8 +11855,8 @@ paths:
x-sandbox: enabled
'/trends/keywords/{region}/top/{trend_type}':
get:
- operationId: trending_keywords/list
summary: List trending keywords
+ operationId: listTrendingKeywords
description: |
Get the top trending search keywords among the Pinterest user audience.
Trending keywords can be used to inform ad targeting, budget strategy, and creative decisions about which products and Pins will resonate with your audience.
Geographic, demographic and interest-based filters are available to narrow down to the top trends among a specific audience. Multiple trend types are supported that can be used to identify newly-popular, evergreen or seasonal keywords.
For an interactive way to explore this data, please visit trends.pinterest.com. parameters: @@ -11902,8 +11931,8 @@ paths: x-sandbox: enabled /user_account: get: - operationId: user_account/get summary: Get user account + operationId: getUserAccount description: |- Get account information for the "operation user_account" - By default, the "operation user_account" is the token user_account. @@ -11944,8 +11973,8 @@ paths: x-sandbox: enabled /user_account/analytics: get: - operationId: user_account/analytics summary: Get user account analytics + operationId: getUserAccountAnalytics description: |- Get analytics for the "operation user_account" - By default, the "operation user_account" is the token user_account. @@ -12002,8 +12031,8 @@ paths: x-sandbox: disabled /user_account/analytics/top_pins: get: - operationId: user_account/analytics/top_pins summary: Get user account top pins analytics + operationId: getUserAccountTopPinsAnalytics description: |- Gets analytics data about a user's top pins (limited to the top 50). - By default, the "operation user_account" is the token user_account. @@ -12057,8 +12086,8 @@ paths: x-sandbox: disabled /user_account/analytics/top_video_pins: get: - operationId: user_account/analytics/top_video_pins summary: Get user account top video pins analytics + operationId: getUserAccountTopVideoPinsAnalytics description: |- Gets analytics data about a user's top video pins (limited to the top 50). - By default, the "operation user_account" is the token user_account. @@ -12112,8 +12141,8 @@ paths: x-sandbox: disabled /user_account/businesses: get: - operationId: linked_business_accounts/get summary: List linked businesses + operationId: listLinkedBusinesses description: Get a list of your linked business accounts. responses: '200': @@ -12141,8 +12170,8 @@ paths: x-sandbox: enabled /user_account/followers: get: - operationId: followers/list summary: List followers + operationId: listFollowers description: Get a list of your followers. parameters: - $ref: '#/components/parameters/query_bookmark' @@ -12187,8 +12216,8 @@ paths: x-sandbox: enabled /user_account/following: get: - operationId: user_following/get summary: List following + operationId: listFollowing description: Get a list of who a certain user follows. parameters: - $ref: '#/components/parameters/query_bookmark' @@ -12227,8 +12256,8 @@ paths: x-sandbox: disabled /user_account/following/boards: get: - operationId: boards_user_follows/list summary: List following boards + operationId: listFollowingBoards description: Get a list of the boards a user follows. The request returns a board summary object array. parameters: - $ref: '#/components/parameters/query_bookmark' @@ -12275,8 +12304,8 @@ paths: x-sandbox: enabled '/user_account/following/{username}': post: - operationId: follow_user/update summary: Follow user + operationId: followUser description: |- This endpoint is currently in beta and not available to all apps. Learn more. @@ -12323,8 +12352,8 @@ paths: x-sandbox: enabled /user_account/websites: post: - operationId: verify_website/update summary: Verify website + operationId: verifyWebsite description: Verify a website as a signed-in user. parameters: - $ref: '#/components/parameters/query_ad_account_id' @@ -12356,8 +12385,8 @@ paths: x-ratelimit-category: org_write x-sandbox: disabled get: - operationId: user_websites/get summary: Get user websites + operationId: getUserWebsites description: 'Get user websites, claimed or not' parameters: - $ref: '#/components/parameters/query_bookmark' @@ -12399,8 +12428,8 @@ paths: x-ratelimit-category: org_read x-sandbox: disabled delete: - operationId: unverify_website/delete summary: Unverify website + operationId: unverifyWebsite description: Unverifu a website verified by the signed-in user. parameters: - $ref: '#/components/parameters/query_website' @@ -12431,8 +12460,8 @@ paths: x-sandbox: disabled /user_account/websites/verification: get: - operationId: website_verification/get summary: Get user verification code for website claiming + operationId: getUserVerificationCodeForWebsiteClaiming description: Get verification code for user to install on the website to claim it. parameters: - $ref: '#/components/parameters/query_ad_account_id' @@ -12469,8 +12498,8 @@ paths: x-sandbox: disabled '/users/{username}/interests/follow': get: - operationId: user_account/followed_interests summary: List following interests + operationId: listFollowingInterests description: Get a list of a user's following interests in one place. parameters: - $ref: '#/components/parameters/path_username' @@ -12526,8 +12555,8 @@ paths: x-sandbox: enabled /trends/topics/featured: get: - operationId: trends_featured_topics/list summary: Get featured topics + operationId: getFeaturedTopics description: ' Enables advertisers to pull top five trending topics by interest and market, at full parity with the Pinterest Trends UI.' parameters: - $ref: '#/components/parameters/query_interest' @@ -12588,8 +12617,8 @@ paths: x-sandbox: disabled /trends/product_categories/details: get: - operationId: trends_product_categories_details/list summary: Get product category details + operationId: getProductCategoryDetails description: ' Enables advertisers to retrieve demographic information, related pins, and trend lines for specified product categories' parameters: - $ref: '#/components/parameters/ProductCategoryIds' @@ -12652,8 +12681,8 @@ paths: x-sandbox: disabled /trends/product_categories/trending: get: - operationId: trends_product_categories_trending/list summary: Get a list of growing Shopping Product Categories + operationId: getAListOfGrowingShoppingProductCategories description: ' Get a list of growing Shopping Product Categories in ranked order allowing filtering by engagement type, vertical, age, and gender.' parameters: - $ref: '#/components/parameters/query_product_category_detail_region' @@ -12717,8 +12746,8 @@ paths: x-sandbox: disabled '/ad_accounts/{ad_account_id}/conversion_eqs': get: - operationId: conversion_eqs/list summary: Get event quality score (EQS) + operationId: getEventQualityScoreEqs description: |- Get the Event Quality Score (EQS) of your conversion signals. diff --git a/reddit.yaml b/reddit.yaml index 90f8a51..aa92ba0 100644 --- a/reddit.yaml +++ b/reddit.yaml @@ -38,6 +38,7 @@ paths: post: tags: [Submissions] summary: Submit a post + operationId: submitPost description: | Submit a link or text post to a subreddit. Supports various post types including text posts, link posts, image posts, video posts, and polls. @@ -136,6 +137,7 @@ paths: get: tags: [Submissions] summary: Get submission and comments + operationId: getSubmissionComments description: Get a submission with its comments thread parameters: - name: article @@ -220,6 +222,7 @@ paths: post: tags: [Comments] summary: Add a comment + operationId: addComment description: Add a comment to a submission or reply to an existing comment requestBody: required: true @@ -261,6 +264,7 @@ paths: post: tags: [Comments] summary: Edit comment or submission text + operationId: editUserText description: Edit the text of a comment or self-post requestBody: required: true @@ -297,6 +301,7 @@ paths: post: tags: [Comments] summary: Delete comment or submission + operationId: deleteContent description: Delete a comment or submission requestBody: required: true @@ -327,6 +332,7 @@ paths: post: tags: [Voting] summary: Vote on a post or comment + operationId: voteOnItem description: Cast an upvote, downvote, or remove vote requestBody: required: true @@ -361,6 +367,7 @@ paths: get: tags: [Submissions] summary: Get information about links/submissions + operationId: getSubmissionInfo description: | Return a listing of links/submissions specified by their fullnames. This is useful for getting detailed information about specific submissions by their IDs. @@ -427,6 +434,7 @@ paths: get: tags: [Subreddits] summary: Get subreddit information + operationId: getSubredditInfo description: Get detailed information about a subreddit parameters: - name: subreddit @@ -460,6 +468,7 @@ paths: get: tags: [Subreddits] summary: Get subreddit posts + operationId: listSubredditPosts description: Get posts from a specific subreddit parameters: - name: subreddit @@ -530,6 +539,7 @@ paths: get: tags: [Users] summary: Get user information + operationId: getUserInfo description: Get public information about a user parameters: - name: username @@ -563,6 +573,7 @@ paths: get: tags: [Users] summary: Get current user info + operationId: getCurrentUser description: Get information about the authenticated user responses: '200': @@ -581,6 +592,7 @@ paths: get: tags: [Users] summary: Get user preferences + operationId: getUserPreferences description: Get the authenticated user's preferences responses: '200': @@ -597,6 +609,7 @@ paths: patch: tags: [Users] summary: Update user preferences + operationId: updateUserPreferences description: Update the authenticated user's preferences requestBody: required: true @@ -623,6 +636,7 @@ paths: get: tags: [Users] summary: Get user trophies + operationId: getUserTrophies description: Get trophies for a specific user parameters: - name: username @@ -659,6 +673,7 @@ paths: get: tags: [Search] summary: Search Reddit content + operationId: searchContent description: Search for submissions, subreddits, or users parameters: - name: q @@ -735,6 +750,7 @@ paths: get: tags: [Messages] summary: Get inbox messages + operationId: getInboxMessages description: Get private messages in the user's inbox parameters: - name: mark @@ -777,6 +793,7 @@ paths: post: tags: [Messages] summary: Send private message + operationId: sendPrivateMessage description: Send a private message to another user requestBody: required: true @@ -823,6 +840,7 @@ paths: post: tags: [Moderation] summary: Approve content + operationId: approveContent description: Approve a submission or comment requestBody: required: true @@ -852,6 +870,7 @@ paths: post: tags: [Moderation] summary: Remove content + operationId: removeContent description: Remove a submission or comment requestBody: required: true @@ -885,6 +904,7 @@ paths: post: tags: [Moderation] summary: Distinguish content + operationId: distinguishContent description: Distinguish a comment or submission as moderator/admin requestBody: required: true @@ -923,6 +943,7 @@ paths: get: tags: [Wiki] summary: Get wiki page + operationId: getWikiPage description: Get the content of a wiki page parameters: - name: subreddit @@ -962,6 +983,7 @@ paths: post: tags: [Wiki] summary: Edit wiki page + operationId: editWikiPage description: Create or edit a wiki page parameters: - name: subreddit @@ -1015,6 +1037,7 @@ paths: post: tags: [User Actions] summary: Save content + operationId: saveContent description: Save a submission or comment requestBody: required: true @@ -1041,6 +1064,7 @@ paths: post: tags: [User Actions] summary: Unsave content + operationId: unsaveContent description: Remove a submission or comment from saved items requestBody: required: true @@ -1065,6 +1089,7 @@ paths: post: tags: [Subscriptions] summary: Subscribe to subreddit + operationId: updateSubscription description: Subscribe or unsubscribe from a subreddit requestBody: required: true @@ -1102,6 +1127,7 @@ paths: get: tags: [Subreddits] summary: Get hot posts from subreddit + operationId: getHotPosts description: Retrieve hot (trending) posts from a specific subreddit parameters: - name: subreddit @@ -1126,6 +1152,7 @@ paths: get: tags: [Subreddits] summary: Get new posts from subreddit + operationId: getNewPosts description: Retrieve newest posts from a specific subreddit in chronological order parameters: - name: subreddit @@ -1150,6 +1177,7 @@ paths: get: tags: [Subreddits] summary: Get top posts from subreddit + operationId: getTopPosts description: Retrieve top-rated posts from a specific subreddit with time filtering parameters: - name: subreddit @@ -1181,6 +1209,7 @@ paths: get: tags: [Subreddits] summary: Get rising posts from subreddit + operationId: getRisingPosts description: Retrieve rapidly trending posts gaining traction parameters: - name: subreddit @@ -1205,6 +1234,7 @@ paths: get: tags: [Subreddits] summary: Get controversial posts from subreddit + operationId: getControversialPosts description: Retrieve posts with high engagement but mixed reactions parameters: - name: subreddit @@ -1237,6 +1267,7 @@ paths: get: tags: [Subreddits] summary: Get posts from all subreddits + operationId: listAllPosts description: Aggregate content from all public subreddits parameters: - $ref: '#/components/parameters/Count' @@ -1255,6 +1286,7 @@ paths: get: tags: [Subreddits] summary: Get popular posts + operationId: getPopularPosts description: Retrieve popular posts filtered by location parameters: - $ref: '#/components/parameters/Count' @@ -1278,6 +1310,7 @@ paths: get: tags: [Subreddits] summary: Get personalized best posts + operationId: getPersonalizedBestPosts description: Returns personalized best content for authenticated users parameters: - $ref: '#/components/parameters/Count' @@ -1299,6 +1332,7 @@ paths: get: tags: [Users] summary: Get user's submitted posts + operationId: getUserSubmittedPosts description: Retrieve posts submitted by a specific user parameters: - name: username @@ -1335,6 +1369,7 @@ paths: get: tags: [Users] summary: Get user's comments + operationId: getUserComments description: Retrieve comments made by a specific user parameters: - name: username @@ -1372,6 +1407,7 @@ paths: get: tags: [Users] summary: Get karma breakdown by subreddit + operationId: getKarmaBreakdown description: Retrieve authenticated user's karma breakdown by subreddit responses: '200': @@ -1404,6 +1440,7 @@ paths: get: tags: [Search] summary: Search within a subreddit + operationId: searchSubreddit description: Search for posts within a specific subreddit parameters: - name: subreddit @@ -1447,6 +1484,7 @@ paths: get: tags: [Search] summary: Search for subreddits + operationId: searchSubreddits description: Find subreddits matching search terms parameters: - name: q @@ -1473,6 +1511,7 @@ paths: get: tags: [Messages] summary: Get unread messages + operationId: getUnreadMessages description: Retrieve only unread messages from inbox parameters: - $ref: '#/components/parameters/Count' @@ -1493,6 +1532,7 @@ paths: get: tags: [Messages] summary: Get sent messages + operationId: getSentMessages description: Retrieve messages sent by the authenticated user parameters: - $ref: '#/components/parameters/Count' @@ -1513,6 +1553,7 @@ paths: post: tags: [Messages] summary: Mark messages as read + operationId: markMessagesRead description: Mark one or more messages as read requestBody: required: true @@ -1544,6 +1585,7 @@ paths: get: tags: [Moderation] summary: Get moderation queue + operationId: getModerationQueue description: Retrieve posts and comments requiring moderation attention parameters: - name: subreddit @@ -1570,6 +1612,7 @@ paths: get: tags: [Moderation] summary: Get reported content + operationId: getReportedContent description: Retrieve reported posts and comments parameters: - name: subreddit @@ -1596,6 +1639,7 @@ paths: get: tags: [Moderation] summary: Get subreddit moderators + operationId: listModerators description: List moderators of a subreddit parameters: - name: subreddit @@ -1637,6 +1681,7 @@ paths: post: tags: [Moderation] summary: Set user flair + operationId: setUserFlair description: Set or clear user flair in a subreddit parameters: - name: subreddit @@ -1679,6 +1724,7 @@ paths: get: tags: [Moderation] summary: Get flair list + operationId: getFlairList description: Get list of users with flair in a subreddit parameters: - name: subreddit @@ -1717,6 +1763,7 @@ paths: get: tags: [Users] summary: Get multireddit + operationId: getMultireddit description: Get information about a multireddit parameters: - name: username @@ -1762,6 +1809,7 @@ paths: get: tags: [Wiki] summary: Get wiki page list + operationId: listWikiPages description: Get list of wiki pages in a subreddit parameters: - name: subreddit @@ -1789,6 +1837,7 @@ paths: get: tags: [Wiki] summary: Get wiki page revisions + operationId: getWikiRevisions description: Get revision history for a wiki page parameters: - name: subreddit @@ -1818,6 +1867,7 @@ paths: post: tags: [Users] summary: Add friend + operationId: addFriend description: Add another user as a friend requestBody: required: true @@ -1848,6 +1898,7 @@ paths: post: tags: [Users] summary: Remove friend + operationId: removeFriend description: Remove a user from friends list requestBody: required: true diff --git a/snapchat.yaml b/snapchat.yaml index 1c4041a..2be6034 100644 --- a/snapchat.yaml +++ b/snapchat.yaml @@ -367,7 +367,7 @@ paths: get: summary: List Public Profile Change Logs description: Returns a list of signed URLs to change logs containing IDs of public profiles that were created, modified, or deleted. - operationId: listChangeLogss + operationId: listChangeLogs parameters: - name: start_at_timestamp in: query diff --git a/telegram.yaml b/telegram.yaml index 4e8374d..9bbf858 100644 --- a/telegram.yaml +++ b/telegram.yaml @@ -4474,4 +4474,5 @@ paths: post: summary: Set Chat Permissions description: | - Use this method to set default chat \ No newline at end of file + Use this method to set default chat + operationId: setChatPermissions \ No newline at end of file diff --git a/threads.yaml b/threads.yaml index 1aa19bb..7d3578d 100644 --- a/threads.yaml +++ b/threads.yaml @@ -33,6 +33,7 @@ paths: post: tags: [Publishing] summary: Create thread + operationId: createThread description: | Create a new thread (post) on Threads. Supports text posts, single media posts, and carousel posts with multiple images. @@ -98,6 +99,7 @@ paths: post: tags: [Publishing] summary: Publish thread + operationId: publishThread description: | Publish a previously created thread. This is a two-step process: 1. Create the thread using `/me/threads` @@ -146,6 +148,7 @@ paths: get: tags: [Profile] summary: Get user profile + operationId: getUserProfile description: Retrieve the authenticated user's Threads profile information parameters: - name: fields @@ -177,6 +180,7 @@ paths: get: tags: [Content Management] summary: Get user threads + operationId: getUserThreads description: Retrieve threads (posts) published by the authenticated user parameters: - name: fields @@ -237,6 +241,7 @@ paths: get: tags: [Content Management] summary: Get thread details + operationId: getThreadDetails description: Retrieve details of a specific thread by ID parameters: - name: thread-id @@ -271,6 +276,7 @@ paths: get: tags: [Analytics] summary: Get thread insights + operationId: getThreadInsights description: Retrieve analytics and performance metrics for a specific thread parameters: - name: thread-id @@ -349,6 +355,7 @@ paths: get: tags: [Analytics] summary: Get user insights + operationId: getUserInsights description: Retrieve analytics for the authenticated user's account parameters: - name: metric @@ -406,6 +413,7 @@ paths: get: tags: [Replies] summary: Get thread replies + operationId: getThreadReplies description: Retrieve replies to a specific thread parameters: - name: thread-id @@ -451,6 +459,7 @@ paths: post: tags: [Replies] summary: Create reply + operationId: createReply description: Reply to a specific thread parameters: - name: thread-id @@ -510,6 +519,7 @@ paths: delete: tags: [Replies] summary: Delete reply + operationId: deleteReply description: Delete a reply created by the authenticated user parameters: - name: reply-id @@ -543,6 +553,7 @@ paths: delete: tags: [Content Management] summary: Delete thread + operationId: deleteThread description: Delete a thread created by the authenticated user parameters: - name: thread-id @@ -576,6 +587,7 @@ paths: post: tags: [Media] summary: Upload media + operationId: uploadMedia description: Upload an image or video to use in threads requestBody: required: true @@ -628,6 +640,7 @@ paths: get: tags: [Media] summary: Get media status + operationId: getMediaStatus description: Check the processing status of uploaded media parameters: - name: media-id @@ -672,6 +685,7 @@ paths: get: tags: [User Management] summary: Get user accounts + operationId: getUserAccounts description: Get all Instagram Business accounts connected to the user responses: '200': @@ -702,6 +716,7 @@ paths: post: tags: [Publishing] summary: Bulk publish threads + operationId: bulkPublishThreads description: Publish multiple threads in a batch operation requestBody: required: true @@ -746,6 +761,7 @@ paths: post: tags: [Content Management] summary: Hide thread + operationId: hideThread description: Hide a thread from the user's profile parameters: - name: thread-id @@ -771,6 +787,7 @@ paths: post: tags: [Content Management] summary: Unhide thread + operationId: unhideThread description: Unhide a previously hidden thread parameters: - name: thread-id @@ -797,6 +814,7 @@ paths: get: tags: [Conversations] summary: Get conversation thread + operationId: getConversationThread description: Get the full conversation thread including all replies parameters: - name: thread-id @@ -831,6 +849,7 @@ paths: get: tags: [Media Management] summary: Get media containers + operationId: getMediaContainers description: Get all media containers created by the user parameters: - name: limit @@ -881,6 +900,7 @@ paths: get: tags: [Analytics] summary: Get demographic insights + operationId: getDemographicInsights description: Get demographic information about followers parameters: - name: metric @@ -923,6 +943,7 @@ paths: get: tags: [Analytics] summary: Get performance insights + operationId: getPerformanceInsights description: Get detailed performance metrics for the account parameters: - name: metric @@ -966,6 +987,7 @@ paths: get: tags: [Content Discovery] summary: Get user feed + operationId: getUserFeed description: Get threads from user's feed parameters: - name: limit @@ -1013,6 +1035,7 @@ paths: get: tags: [Content Discovery] summary: Get trending threads + operationId: getTrendingThreads description: Get currently trending threads parameters: - name: limit @@ -1049,6 +1072,7 @@ paths: get: tags: [Search] summary: Search threads + operationId: searchThreads description: Search for threads and users parameters: - name: q @@ -1103,6 +1127,7 @@ paths: get: tags: [User Management] summary: Get followers + operationId: getFollowers description: Get list of users who follow the authenticated user parameters: - name: limit @@ -1144,6 +1169,7 @@ paths: get: tags: [User Management] summary: Get following + operationId: getFollowing description: Get list of users that the authenticated user is following parameters: - name: limit @@ -1186,6 +1212,7 @@ paths: get: tags: [Account Management] summary: Get rate limit status + operationId: getRateLimitStatus description: Get current rate limit status for publishing responses: '200': @@ -1218,6 +1245,7 @@ paths: get: tags: [Webhooks] summary: Get webhook subscriptions + operationId: getWebhookSubscriptions description: Get current webhook subscriptions responses: '200': @@ -1248,6 +1276,7 @@ paths: post: tags: [Webhooks] summary: Create webhook subscription + operationId: createWebhookSubscription description: Subscribe to webhook events for real-time updates requestBody: required: true diff --git a/tiktok.yaml b/tiktok.yaml index 7ddc06e..7de4c6b 100644 --- a/tiktok.yaml +++ b/tiktok.yaml @@ -298,6 +298,7 @@ paths: servers: - url: https://www.tiktok.com/v2 summary: Get TikTok authorization URL + operationId: getAuthorizationUrl description: Redirect user to TikTok authorization page parameters: - name: client_key @@ -345,6 +346,7 @@ paths: /oauth/token/: post: summary: Exchange authorization code for access token or refresh token + operationId: exchangeToken requestBody: required: true content: @@ -393,6 +395,7 @@ paths: /v2/user/info/: get: summary: Get user profile information + operationId: getUserInfoV2 description: | Returns basic information for a given TikTok user. This is the v2 API endpoint (current). Requires relevant scopes to be authorized by the TikTok user. @@ -432,6 +435,7 @@ paths: /user/info/: post: summary: Get user profile information (v1 - Deprecated) + operationId: getUserInfoV1 description: | **DEPRECATED**: Use GET /v2/user/info/ instead. This is the legacy v1 API endpoint. TikTok recommends migrating to v2. @@ -476,6 +480,7 @@ paths: /post/publish/creator_info/query/: post: summary: Get creator information for UX compliance + operationId: getCreatorInfoForUx description: Required before showing TikTok posting interface to ensure UX compliance security: - AccessToken: [] @@ -503,6 +508,7 @@ paths: /post/publish/video/init/: post: summary: Initialize video post (Direct Post or Creator Inbox) + operationId: initializeVideoPost description: Publish video directly or send to Creator Inbox based on post_mode security: - AccessToken: [] @@ -546,6 +552,7 @@ paths: /post/publish/content/init/: post: summary: Initialize photo/carousel post (Direct Post or Creator Inbox) + operationId: initializeContentPost description: Publish photos directly or send to Creator Inbox based on post_mode security: - AccessToken: [] @@ -600,6 +607,7 @@ paths: /post/publish/inbox/video/init/: post: summary: Send video to Creator Inbox as draft + operationId: sendVideoToCreatorInbox description: Upload video to Creator Inbox for later publishing (draft mode) security: - AccessToken: [] @@ -664,6 +672,7 @@ paths: /post/publish/status/fetch/: post: summary: Check publishing status + operationId: fetchPublishStatus description: Poll the status of a video/photo upload security: - AccessToken: [] @@ -694,6 +703,7 @@ paths: /video/list/: post: summary: Get user's published videos + operationId: listUserVideos security: - AccessToken: [] parameters: @@ -746,6 +756,7 @@ paths: /video/query/: post: summary: Get video analytics + operationId: queryVideoAnalytics security: - AccessToken: [] parameters: @@ -792,6 +803,7 @@ paths: /comment/publish/: post: summary: Post comment or reply to comment + operationId: publishComment description: TikTok comments API is write-only (cannot read existing comments) security: - AccessToken: [] @@ -839,6 +851,7 @@ paths: /comment/delete/: post: summary: Delete comment + operationId: deleteComment security: - AccessToken: [] requestBody: @@ -875,6 +888,7 @@ paths: /research/video/query/: post: summary: Query TikTok public content data (Research API) + operationId: queryResearchVideos description: Query videos with conditions like region, keywords, hashtags, etc. security: - AccessToken: [] @@ -998,6 +1012,7 @@ paths: /research/user/info/: post: summary: Get public TikTok account information (Research API) + operationId: queryResearchUserInfo description: Query public TikTok account information by username security: - AccessToken: [] @@ -1058,6 +1073,7 @@ paths: /oauth/revoke/: post: summary: Revoke access token + operationId: revokeToken description: Revoke an access token and invalidate it requestBody: required: true @@ -1087,6 +1103,7 @@ paths: /oauth/client_credentials/: post: summary: Get client access token + operationId: getClientAccessToken description: Generate client access token for Research API requestBody: required: true @@ -1128,6 +1145,7 @@ paths: /user/info/extended/: post: summary: Get extended user profile information (Display API) + operationId: getExtendedUserInfo description: Get extended user information including stats and profile details security: - AccessToken: [] @@ -1190,6 +1208,7 @@ paths: /post/publish/creator_info/query/: get: summary: Get creator information for UX compliance (alternative endpoint) + operationId: getCreatorInfoForUxAlt description: Alternative GET endpoint for creator information security: - AccessToken: [] @@ -1208,6 +1227,7 @@ paths: /share/video/: post: summary: Share video to TikTok app (Share Kit) + operationId: shareVideoToApp description: Share video content directly to TikTok mobile app security: - AccessToken: [] @@ -1254,6 +1274,7 @@ paths: /video/embed/: post: summary: Get video embed information + operationId: getVideoEmbedInfo description: Get embed links and metadata for TikTok videos security: - AccessToken: [] @@ -1303,6 +1324,7 @@ paths: /oauth/token/info/: post: summary: Get token information + operationId: getTokenInfo description: Get information about an access token (scopes, expiry, etc.) security: - AccessToken: [] @@ -1333,6 +1355,7 @@ paths: /{upload_url}: put: summary: Upload video file chunks + operationId: uploadFileChunk description: Upload video data using chunked upload (for FILE_UPLOAD method) parameters: - name: upload_url diff --git a/youtube.yaml b/youtube.yaml index 5d25743..80e3cab 100644 --- a/youtube.yaml +++ b/youtube.yaml @@ -28,6 +28,7 @@ paths: get: tags: [Activities] summary: List channel activities + operationId: listChannelActivities description: Returns a list of channel activity events that match the request criteria parameters: - name: part @@ -98,6 +99,7 @@ paths: get: tags: [Captions] summary: List caption tracks + operationId: listCaptionTracks description: Returns a list of caption tracks associated with a video parameters: - name: part @@ -137,6 +139,7 @@ paths: post: tags: [Captions] summary: Upload caption track + operationId: uploadCaptionTrack description: Uploads a caption track for a video parameters: - name: part @@ -184,6 +187,7 @@ paths: put: tags: [Captions] summary: Update caption track + operationId: updateCaptionTrack description: Updates an existing caption track parameters: - name: part @@ -231,6 +235,7 @@ paths: delete: tags: [Captions] summary: Delete caption track + operationId: deleteCaptionTrack description: Deletes a caption track parameters: - name: id @@ -254,6 +259,7 @@ paths: get: tags: [Captions] summary: Download caption track + operationId: downloadCaptionTrack description: Downloads a caption track parameters: - name: id @@ -299,6 +305,7 @@ paths: get: tags: [Channels] summary: List channels + operationId: listChannels description: Returns a collection of zero or more channel resources parameters: - name: part @@ -370,6 +377,7 @@ paths: put: tags: [Channels] summary: Update channel + operationId: updateChannel description: Updates a channel's metadata parameters: - name: part @@ -404,6 +412,7 @@ paths: get: tags: [Channel Sections] summary: List channel sections + operationId: listChannelSections description: Returns channel sections that match the request criteria parameters: - name: part @@ -447,6 +456,7 @@ paths: post: tags: [Channel Sections] summary: Create channel section + operationId: createChannelSection description: Adds a channel section to the authenticated user's channel parameters: - name: part @@ -484,6 +494,7 @@ paths: put: tags: [Channel Sections] summary: Update channel section + operationId: updateChannelSection description: Updates a channel section parameters: - name: part @@ -516,6 +527,7 @@ paths: delete: tags: [Channel Sections] summary: Delete channel section + operationId: deleteChannelSection description: Deletes a channel section parameters: - name: id @@ -540,6 +552,7 @@ paths: get: tags: [Videos] summary: List videos + operationId: listVideos description: Returns a list of videos that match the API request parameters parameters: - name: part @@ -618,6 +631,7 @@ paths: post: tags: [Videos] summary: Upload video + operationId: uploadVideo description: Uploads a video to YouTube and optionally sets the video's metadata parameters: - name: part @@ -678,6 +692,7 @@ paths: put: tags: [Videos] summary: Update video + operationId: updateVideo description: Updates a video's metadata parameters: - name: part @@ -710,6 +725,7 @@ paths: delete: tags: [Videos] summary: Delete video + operationId: deleteVideo description: Deletes a YouTube video parameters: - name: id @@ -733,6 +749,7 @@ paths: post: tags: [Videos] summary: Rate video + operationId: rateVideo description: Add a like or dislike rating to a video or remove a rating parameters: - name: id @@ -758,6 +775,7 @@ paths: get: tags: [Videos] summary: Get video ratings + operationId: getVideoRatings description: Retrieves the ratings that the authorized user gave to specified videos parameters: - name: id @@ -785,6 +803,7 @@ paths: post: tags: [Videos] summary: Report video abuse + operationId: reportVideoAbuse description: Report a video for containing abusive content parameters: - name: onBehalfOfContentOwner @@ -809,6 +828,7 @@ paths: get: tags: [Playlists] summary: List playlists + operationId: listPlaylists description: Returns a collection of playlists that match the API request parameters parameters: - name: part @@ -870,6 +890,7 @@ paths: post: tags: [Playlists] summary: Create playlist + operationId: createPlaylist description: Creates a playlist parameters: - name: part @@ -907,6 +928,7 @@ paths: put: tags: [Playlists] summary: Update playlist + operationId: updatePlaylist description: Modifies a playlist parameters: - name: part @@ -939,6 +961,7 @@ paths: delete: tags: [Playlists] summary: Delete playlist + operationId: deletePlaylist description: Deletes a playlist parameters: - name: id @@ -963,6 +986,7 @@ paths: get: tags: [Playlist Items] summary: List playlist items + operationId: listPlaylistItems description: Returns a collection of playlist items that match the API request parameters parameters: - name: part @@ -1019,6 +1043,7 @@ paths: post: tags: [Playlist Items] summary: Add item to playlist + operationId: addItemToPlaylist description: Adds a resource to a playlist parameters: - name: part @@ -1051,6 +1076,7 @@ paths: put: tags: [Playlist Items] summary: Update playlist item + operationId: updatePlaylistItem description: Modifies a playlist item parameters: - name: part @@ -1083,6 +1109,7 @@ paths: delete: tags: [Playlist Items] summary: Remove item from playlist + operationId: removeItemFromPlaylist description: Deletes a playlist item parameters: - name: id @@ -1107,6 +1134,7 @@ paths: get: tags: [Search] summary: Search for YouTube content + operationId: searchForYoutubeContent description: Returns a collection of search results that match the query parameters parameters: - name: part @@ -1261,6 +1289,7 @@ paths: get: tags: [Subscriptions] summary: List subscriptions + operationId: listSubscriptions description: Returns subscription resources that match the API request criteria parameters: - name: part @@ -1343,6 +1372,7 @@ paths: post: tags: [Subscriptions] summary: Subscribe to channel + operationId: subscribeToChannel description: Adds a subscription for the authenticated user's channel parameters: - name: part @@ -1370,6 +1400,7 @@ paths: delete: tags: [Subscriptions] summary: Unsubscribe from channel + operationId: unsubscribeFromChannel description: Deletes a subscription parameters: - name: id @@ -1389,6 +1420,7 @@ paths: get: tags: [Comments] summary: List comment threads + operationId: listCommentThreads description: Returns a list of comment threads that match the API request parameters parameters: - name: part @@ -1471,6 +1503,7 @@ paths: get: tags: [Comments] summary: List comments + operationId: listComments description: Returns a list of comments that match the API request parameters parameters: - name: part @@ -1526,6 +1559,7 @@ paths: post: tags: [Thumbnails] summary: Set video thumbnail + operationId: setVideoThumbnail description: Uploads a custom video thumbnail to YouTube and sets it for a video parameters: - name: videoId @@ -1565,6 +1599,7 @@ paths: get: tags: [Video Categories] summary: List video categories + operationId: listVideoCategories description: Returns a list of categories that can be associated with YouTube videos parameters: - name: part @@ -1606,6 +1641,7 @@ paths: get: tags: [Video Abuse Report Reasons] summary: List video abuse report reasons + operationId: listVideoAbuseReportReasons description: Retrieve a list of reasons that can be used to report abusive videos parameters: - name: part @@ -1636,6 +1672,7 @@ paths: get: tags: [I18n Languages] summary: List supported languages + operationId: listSupportedLanguages description: Returns a list of application languages that the YouTube website supports parameters: - name: part @@ -1666,6 +1703,7 @@ paths: get: tags: [I18n Regions] summary: List supported regions + operationId: listSupportedRegions description: Returns a list of content regions that the YouTube website supports parameters: - name: part @@ -1696,6 +1734,7 @@ paths: get: tags: [Members] summary: List channel members + operationId: listChannelMembers description: Lists members for a channel parameters: - name: part @@ -1745,6 +1784,7 @@ paths: get: tags: [Membership Levels] summary: List membership levels + operationId: listMembershipLevels description: Returns a collection of membership levels owned by the channel that authorized the API request parameters: - name: part @@ -1769,6 +1809,7 @@ paths: post: tags: [Watermarks] summary: Set channel watermark + operationId: setChannelWatermark description: Uploads a watermark image to YouTube and sets it for a channel parameters: - name: channelId @@ -1805,6 +1846,7 @@ paths: post: tags: [Watermarks] summary: Remove channel watermark + operationId: removeChannelWatermark description: Deletes a channel's watermark image parameters: - name: channelId @@ -3559,4 +3601,4 @@ tags: - name: Membership Levels description: Channel membership level management - name: Watermarks - description: Channel watermark management \ No newline at end of file + description: Channel watermark management