Retrieves all Facebook or YouTube Clipping profiles.
Request
Request syntax:
GET /syndication-clipping-profiles?service=Social Media or Content Distribution Platform
Query string parameter:
Pass the following query string parameter:
| Name | Description | |
|---|---|---|
| service Required | Set it to either of the following values: Facebook | YouTube |
Response
The response for a successful request contains the following properties:
| Name | Data Type | Description |
|---|---|---|
| @id | String | Indicates the relative path to the requested endpoint. |
| @type | String | Returns Collection. |
| items | List of dictionaries | Contains a list of Clipping profiles. |
| total_items | Integer | Indicates the total number of Clipping profiles. |
items List
The items list describes each clipping profile via the following properties:
| Name | Data Type | Description |
|---|---|---|
| id | String | Identifies this Clipping profile by its system-defined ID. |
| name | String | Identifies this Clipping profile by its name. |
Sample Request/Response
The code below (Python 3) shows how to get the rays corresponding to retrieve Clipping profiles.
This code imports names from the api_auth module for V4 APIs (see below).
🦉
API Auth for Classic Authentication (V4 APIs)
Open Recipe
import requests
from api_auth import APICredentials, APIParams
class ClippingProfiles:
def __init__(self):
self.host = "https://services.uplynk.com"
def run(self):
self._get_clipping_profiles()
def _get_clipping_profiles(self):
platform = 'YouTube'
url = "{}{}{}".format(self.host, "/api/v4/syndication-clipping-profiles?service=", platform)
headers = {'Content-Type': 'application/json'}
response = requests.get(
url, params=APIParams(APICredentials()).get_params({}), headers=headers
)
print(response.json())
ClippingProfiles().run()Response:
{
"@id": "/api/v4/syndication-clipping-profiles?service=YouTube",
"@type": "Collection",
"items": [{
"id": "4f3d0b8d4c37457eae629506528c982c",
"name": "Marketing Conferences - YouTube"
}
],
"total_items": 1
}