openapi_generated.pinterest_client.UserAccountApi

All URIs are relative to https://api.pinterest.com/v5

Method	HTTP request	Description
boards_user_follows_list	GET /user_account/following/boards	List following boards
follow_user_update	POST /user_account/following/{username}	Follow user
followers_list	GET /user_account/followers	List followers
linked_business_accounts_get	GET /user_account/businesses	List linked businesses
unverify_website_delete	DELETE /user_account/websites	Unverify website
user_account_analytics	GET /user_account/analytics	Get user account analytics
user_account_analytics_top_pins	GET /user_account/analytics/top_pins	Get user account top pins analytics
user_account_analytics_top_video_pins	GET /user_account/analytics/top_video_pins	Get user account top video pins analytics
user_account_get	GET /user_account	Get user account
user_following_get	GET /user_account/following	List following
user_websites_get	GET /user_account/websites	Get user websites
verify_website_update	POST /user_account/websites	Verify website
website_verification_get	GET /user_account/websites/verification	Get user verification code for website claiming

boards_user_follows_list

bool, date, datetime, dict, float, int, list, str, none_type boards_user_follows_list()

List following boards

Get a list of the boards a user follows. The request returns a board summary object array.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.paginated import Paginated
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)
    bookmark = "bookmark_example" # str | Cursor used to fetch the next page of items (optional)
    explicit_following = False # bool | Whether or not to include implicit user follows, which means followees with board follows. When explicit_following is True, it means we only want explicit user follows. (optional) if omitted the server will use the default value of False
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List following boards
        api_response = api_instance.boards_user_follows_list(bookmark=bookmark, explicit_following=explicit_following, ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->boards_user_follows_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
bookmark	str	Cursor used to fetch the next page of items	[optional]
explicit_following	bool	Whether or not to include implicit user follows, which means followees with board follows. When explicit_following is True, it means we only want explicit user follows.	[optional] if omitted the server will use the default value of False
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

bool, date, datetime, dict, float, int, list, str, none_type

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Invalid user id	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

follow_user_update

UserSummary follow_user_update(username, follow_user_request)

Follow user

This endpoint is currently in beta and not available to all apps. Learn more. Use this request, as a signed-in user, to follow another user.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.follow_user_request import FollowUserRequest
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.user_summary import UserSummary
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)
    username = "username" # str | A valid username
    follow_user_request = FollowUserRequest(
        auto_follow=False,
    ) # FollowUserRequest | Follow a user.

    # example passing only required values which don't have defaults set
    try:
        # Follow user
        api_response = api_instance.follow_user_update(username, follow_user_request)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->follow_user_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
username	str	A valid username
follow_user_request	FollowUserRequest	Follow a user.

Return type

UserSummary

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
404	User not found	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

followers_list

bool, date, datetime, dict, float, int, list, str, none_type followers_list()

List followers

Get a list of your followers, or a specific user's followers.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.paginated import Paginated
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)
    bookmark = "bookmark_example" # str | Cursor used to fetch the next page of items (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List followers
        api_response = api_instance.followers_list(bookmark=bookmark)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->followers_list: %s\n" % e)

Parameters

Name	Type	Description	Notes
bookmark	str	Cursor used to fetch the next page of items	[optional]

Return type

bool, date, datetime, dict, float, int, list, str, none_type

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Invalid user id	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

linked_business_accounts_get

[LinkedBusiness] linked_business_accounts_get()

List linked businesses

Get a list of your linked business accounts.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.linked_business import LinkedBusiness
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # List linked businesses
        api_response = api_instance.linked_business_accounts_get()
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->linked_business_accounts_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

[LinkedBusiness]

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

unverify_website_delete

unverify_website_delete(website)

Unverify website

Unverifu a website verified by the signed-in user.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)
    website = "mysite.test" # str | Website with path or domain only

    # example passing only required values which don't have defaults set
    try:
        # Unverify website
        api_instance.unverify_website_delete(website)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->unverify_website_delete: %s\n" % e)

Parameters

Name	Type	Description	Notes
website	str	Website with path or domain only

Return type

void (empty response body)

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
204	Successfully unverified website	-
404	Website not in user list.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_account_analytics

AnalyticsResponse user_account_analytics(start_date, end_date)

Get user account analytics

Get analytics for the "operation user_account" - By default, the "operation user_account" is the token user_account. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account".

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.analytics_response import AnalyticsResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)
    start_date = dateutil_parser('1970-01-01').date() # date | Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
    end_date = dateutil_parser('1970-01-01').date() # date | Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
    from_claimed_content = "BOTH" # str | Filter on Pins that match your claimed domain. (optional) if omitted the server will use the default value of "BOTH"
    pin_format = "ALL" # str | Pin formats to get data for, default is all. (optional) if omitted the server will use the default value of "ALL"
    app_types = "ALL" # str | Apps or devices to get data for, default is all. (optional) if omitted the server will use the default value of "ALL"
    source = "ALL" # str | Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts (optional) if omitted the server will use the default value of "ALL"
    metric_types = [
        "ENGAGEMENT",
    ] # [str] | Metric types to get data for, default is all.  (optional)
    split_field = "NO_SPLIT" # str | How to split the data into groups. Not including this param means data won't be split. (optional) if omitted the server will use the default value of "NO_SPLIT"
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get user account analytics
        api_response = api_instance.user_account_analytics(start_date, end_date)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->user_account_analytics: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get user account analytics
        api_response = api_instance.user_account_analytics(start_date, end_date, from_claimed_content=from_claimed_content, pin_format=pin_format, app_types=app_types, source=source, metric_types=metric_types, split_field=split_field, ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->user_account_analytics: %s\n" % e)

Parameters

Name	Type	Description	Notes
start_date	date	Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
end_date	date	Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
from_claimed_content	str	Filter on Pins that match your claimed domain.	[optional] if omitted the server will use the default value of "BOTH"
pin_format	str	Pin formats to get data for, default is all.	[optional] if omitted the server will use the default value of "ALL"
app_types	str	Apps or devices to get data for, default is all.	[optional] if omitted the server will use the default value of "ALL"
source	str	Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts	[optional] if omitted the server will use the default value of "ALL"
metric_types	[str]	Metric types to get data for, default is all.	[optional]
split_field	str	How to split the data into groups. Not including this param means data won't be split.	[optional] if omitted the server will use the default value of "NO_SPLIT"
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

AnalyticsResponse

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
400	Invalid user accounts analytics parameters.	-
403	Not authorized to access the user account analytics.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_account_analytics_top_pins

TopPinsAnalyticsResponse user_account_analytics_top_pins(start_date, end_date, sort_by)

Get user account top pins analytics

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. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account".

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.top_pins_analytics_response import TopPinsAnalyticsResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)
    start_date = dateutil_parser('1970-01-01').date() # date | Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
    end_date = dateutil_parser('1970-01-01').date() # date | Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
    sort_by = "ENGAGEMENT" # str | Specify sorting order for metrics
    from_claimed_content = "BOTH" # str | Filter on Pins that match your claimed domain. (optional) if omitted the server will use the default value of "BOTH"
    pin_format = "ALL" # str | Pin formats to get data for, default is all. (optional) if omitted the server will use the default value of "ALL"
    app_types = "ALL" # str | Apps or devices to get data for, default is all. (optional) if omitted the server will use the default value of "ALL"
    content_type = "ALL" # str | Filter to paid or organic data. Default is all. (optional) if omitted the server will use the default value of "ALL"
    source = "ALL" # str | Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts (optional) if omitted the server will use the default value of "ALL"
    metric_types = [
        "ENGAGEMENT",
    ] # [str] | Metric types to get data for, default is all.  (optional)
    num_of_pins = 25 # int | Number of pins to include, default is 10. Max is 50. (optional) if omitted the server will use the default value of 10
    created_in_last_n_days = 30 # int | Get metrics for pins created in the last \"n\" days. (optional) if omitted the server will use the default value of 30
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get user account top pins analytics
        api_response = api_instance.user_account_analytics_top_pins(start_date, end_date, sort_by)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->user_account_analytics_top_pins: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get user account top pins analytics
        api_response = api_instance.user_account_analytics_top_pins(start_date, end_date, sort_by, from_claimed_content=from_claimed_content, pin_format=pin_format, app_types=app_types, content_type=content_type, source=source, metric_types=metric_types, num_of_pins=num_of_pins, created_in_last_n_days=created_in_last_n_days, ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->user_account_analytics_top_pins: %s\n" % e)

Parameters

Name	Type	Description	Notes
start_date	date	Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
end_date	date	Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
sort_by	str	Specify sorting order for metrics
from_claimed_content	str	Filter on Pins that match your claimed domain.	[optional] if omitted the server will use the default value of "BOTH"
pin_format	str	Pin formats to get data for, default is all.	[optional] if omitted the server will use the default value of "ALL"
app_types	str	Apps or devices to get data for, default is all.	[optional] if omitted the server will use the default value of "ALL"
content_type	str	Filter to paid or organic data. Default is all.	[optional] if omitted the server will use the default value of "ALL"
source	str	Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts	[optional] if omitted the server will use the default value of "ALL"
metric_types	[str]	Metric types to get data for, default is all.	[optional]
num_of_pins	int	Number of pins to include, default is 10. Max is 50.	[optional] if omitted the server will use the default value of 10
created_in_last_n_days	int	Get metrics for pins created in the last "n" days.	[optional] if omitted the server will use the default value of 30
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

TopPinsAnalyticsResponse

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Not authorized to access the user account analytics.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_account_analytics_top_video_pins

TopVideoPinsAnalyticsResponse user_account_analytics_top_video_pins(start_date, end_date, sort_by)

Get user account top video pins analytics

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. Optional: Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account".

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.top_video_pins_analytics_response import TopVideoPinsAnalyticsResponse
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)
    start_date = dateutil_parser('1970-01-01').date() # date | Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
    end_date = dateutil_parser('1970-01-01').date() # date | Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
    sort_by = "IMPRESSION" # str | Specify sorting order for video metrics
    from_claimed_content = "BOTH" # str | Filter on Pins that match your claimed domain. (optional) if omitted the server will use the default value of "BOTH"
    pin_format = "ALL" # str | Pin formats to get data for, default is all. (optional) if omitted the server will use the default value of "ALL"
    app_types = "ALL" # str | Apps or devices to get data for, default is all. (optional) if omitted the server will use the default value of "ALL"
    content_type = "ALL" # str | Filter to paid or organic data. Default is all. (optional) if omitted the server will use the default value of "ALL"
    source = "ALL" # str | Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts (optional) if omitted the server will use the default value of "ALL"
    metric_types = [
        "IMPRESSION",
    ] # [str] | Metric types to get video data for, default is all.  (optional)
    num_of_pins = 25 # int | Number of pins to include, default is 10. Max is 50. (optional) if omitted the server will use the default value of 10
    created_in_last_n_days = 30 # int | Get metrics for pins created in the last \"n\" days. (optional) if omitted the server will use the default value of 30
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    try:
        # Get user account top video pins analytics
        api_response = api_instance.user_account_analytics_top_video_pins(start_date, end_date, sort_by)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->user_account_analytics_top_video_pins: %s\n" % e)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get user account top video pins analytics
        api_response = api_instance.user_account_analytics_top_video_pins(start_date, end_date, sort_by, from_claimed_content=from_claimed_content, pin_format=pin_format, app_types=app_types, content_type=content_type, source=source, metric_types=metric_types, num_of_pins=num_of_pins, created_in_last_n_days=created_in_last_n_days, ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->user_account_analytics_top_video_pins: %s\n" % e)

Parameters

Name	Type	Description	Notes
start_date	date	Metric report start date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days back from today.
end_date	date	Metric report end date (UTC). Format: YYYY-MM-DD. Cannot be more than 90 days past start_date.
sort_by	str	Specify sorting order for video metrics
from_claimed_content	str	Filter on Pins that match your claimed domain.	[optional] if omitted the server will use the default value of "BOTH"
pin_format	str	Pin formats to get data for, default is all.	[optional] if omitted the server will use the default value of "ALL"
app_types	str	Apps or devices to get data for, default is all.	[optional] if omitted the server will use the default value of "ALL"
content_type	str	Filter to paid or organic data. Default is all.	[optional] if omitted the server will use the default value of "ALL"
source	str	Filter to activity from Pins created and saved by your, or activity created and saved by others from your claimed accounts	[optional] if omitted the server will use the default value of "ALL"
metric_types	[str]	Metric types to get video data for, default is all.	[optional]
num_of_pins	int	Number of pins to include, default is 10. Max is 50.	[optional] if omitted the server will use the default value of 10
created_in_last_n_days	int	Get metrics for pins created in the last "n" days.	[optional] if omitted the server will use the default value of 30
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

TopVideoPinsAnalyticsResponse

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Not authorized to access the user account analytics.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_account_get

Account user_account_get()

Get user account

Get account information for the "operation user_account" - By default, the "operation user_account" is the token user_account. If using Business Access: Specify an ad_account_id to use the owner of that ad_account as the "operation user_account". See Understanding Business Access for more information.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.account import Account
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get user account
        api_response = api_instance.user_account_get(ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->user_account_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

Account

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	response	-
403	Not authorized to access the user account.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_following_get

bool, date, datetime, dict, float, int, list, str, none_type user_following_get()

List following

Get a list of who a certain user follows.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.paginated import Paginated
from openapi_generated.pinterest_client.model.user_following_feed_type import UserFollowingFeedType
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)
    bookmark = "bookmark_example" # str | Cursor used to fetch the next page of items (optional)
    feed_type = UserFollowingFeedType("CREATOR_ONLY") # UserFollowingFeedType | Thrift param specifying what type of followees will be kept. Default to include all followees. (optional)
    explicit_following = False # bool | Whether or not to include implicit user follows, which means followees with board follows. When explicit_following is True, it means we only want explicit user follows. (optional) if omitted the server will use the default value of False
    ad_account_id = "4" # str | Unique identifier of an ad account. (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # List following
        api_response = api_instance.user_following_get(bookmark=bookmark, feed_type=feed_type, explicit_following=explicit_following, ad_account_id=ad_account_id)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->user_following_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
bookmark	str	Cursor used to fetch the next page of items	[optional]
feed_type	UserFollowingFeedType	Thrift param specifying what type of followees will be kept. Default to include all followees.	[optional]
explicit_following	bool	Whether or not to include implicit user follows, which means followees with board follows. When explicit_following is True, it means we only want explicit user follows.	[optional] if omitted the server will use the default value of False
ad_account_id	str	Unique identifier of an ad account.	[optional]

Return type

bool, date, datetime, dict, float, int, list, str, none_type

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	response	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

user_websites_get

bool, date, datetime, dict, float, int, list, str, none_type user_websites_get()

Get user websites

Get user websites, claimed or not

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.paginated import Paginated
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)
    bookmark = "bookmark_example" # str | Cursor used to fetch the next page of items (optional)

    # example passing only required values which don't have defaults set
    # and optional values
    try:
        # Get user websites
        api_response = api_instance.user_websites_get(bookmark=bookmark)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->user_websites_get: %s\n" % e)

Parameters

Name	Type	Description	Notes
bookmark	str	Cursor used to fetch the next page of items	[optional]

Return type

bool, date, datetime, dict, float, int, list, str, none_type

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Not authorized to access the user website list.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

verify_website_update

UserWebsiteSummary verify_website_update(user_website_verify_request)

Verify website

Verify a website as a signed-in user.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.user_website_summary import UserWebsiteSummary
from openapi_generated.pinterest_client.model.user_website_verify_request import UserWebsiteVerifyRequest
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)
    user_website_verify_request = UserWebsiteVerifyRequest(
        website="pintest-website-12345678.test/test_1",
        verification_method="METATAG",
    ) # UserWebsiteVerifyRequest | Verify a website.

    # example passing only required values which don't have defaults set
    try:
        # Verify website
        api_response = api_instance.verify_website_update(user_website_verify_request)
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->verify_website_update: %s\n" % e)

Parameters

Name	Type	Description	Notes
user_website_verify_request	UserWebsiteVerifyRequest	Verify a website.

Return type

UserWebsiteSummary

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: application/json
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

website_verification_get

UserWebsiteVerificationCode website_verification_get()

Get user verification code for website claiming

Get verification code for user to install on the website to claim it.

Example

OAuth Authentication (pinterest_oauth2):

import time
import openapi_generated.pinterest_client
from openapi_generated.pinterest_client.api import user_account_api
from openapi_generated.pinterest_client.model.error import Error
from openapi_generated.pinterest_client.model.user_website_verification_code import UserWebsiteVerificationCode
from pprint import pprint
# Defining the host is optional and defaults to https://api.pinterest.com/v5
# See configuration.py for a list of all supported configuration parameters.
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure OAuth2 access token for authorization: pinterest_oauth2
configuration = openapi_generated.pinterest_client.Configuration(
    host = "https://api.pinterest.com/v5"
)
configuration.access_token = 'YOUR_ACCESS_TOKEN'

# Enter a context with an instance of the API client
with openapi_generated.pinterest_client.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = user_account_api.UserAccountApi(api_client)

    # example, this endpoint has no required or optional parameters
    try:
        # Get user verification code for website claiming
        api_response = api_instance.website_verification_get()
        pprint(api_response)
    except openapi_generated.pinterest_client.ApiException as e:
        print("Exception when calling UserAccountApi->website_verification_get: %s\n" % e)

Parameters

This endpoint does not need any parameter.

Return type

UserWebsiteVerificationCode

Authorization

pinterest_oauth2

HTTP request headers

Content-Type: Not defined
Accept: application/json

HTTP response details

Status code	Description	Response headers
200	Success	-
403	Not authorized to access the user verification code for website claiming.	-
0	Unexpected error	-

[Back to top] [Back to API list] [Back to Model list] [Back to README]

Files

UserAccountApi.md

Latest commit

History

UserAccountApi.md

File metadata and controls

openapi_generated.pinterest_client.UserAccountApi

boards_user_follows_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

follow_user_update

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

followers_list

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

linked_business_accounts_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

unverify_website_delete

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

user_account_analytics

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

user_account_analytics_top_pins

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

user_account_analytics_top_video_pins

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

user_account_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

user_following_get

Example

Parameters

Return type

Authorization

HTTP request headers

HTTP response details

user_websites_get

Example

Parameters