### Profile Lookup Example (URL) Source: https://developers.wyng.com/api/profiles This example demonstrates how to construct a URL for the profile lookup endpoint. It shows how to pass multiple IDs (uid and email) as URL parameters to search for a matching profile in the data model. ```bash /profiles/lookup?uid=&email= ``` -------------------------------- ### Define Wyng Profile Fields (JSON) Source: https://developers.wyng.com/api/profiles This example shows how to define fields for a Wyng profile, specifying their ID, name, type, and status. It includes examples for 'text' type fields, one of which is marked as internal. ```json [ { "id": "email", "name": "Email", "type": "text", "status": "active" }, { "id": "skin_concerns", "name": "Skin Concerns", "type": "text", "is_internal": true } ] ``` -------------------------------- ### Get Tags for UGC Item (JSON Response Example) Source: https://developers.wyng.com/api/content This is a sample JSON response for the 'Get Tags associated with a content item' endpoint. It includes details about the total results, embedded tag information, and associated metadata like campaign, author, and content. ```json { "total_results": 1, "_embedded": { "ugc:tags": [ { "entry_confirmation_sent": false, "approval_status": "pen", "campaign": 16252, "default_activate_unit": { "image_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/560e56c0ef95a64962c14d37/560e56c0ef95a6477eb62eab.JPEG", "name": "Hooded Shell Jacket", "click_through_url": "http://www.futurism.me/products/fitted", "catalog_item": null, "catalog_image_url_src": null, "external_id": null, "id": 1234, "archived": false, "managed": true, "created_on": "2015-10-02T10:12:46Z", "click_unit_library": 420, "last_modified": "2015-10-02T10:12:46Z", "associated_contents": [], "activate_unit_library": 420 }, "submission": null, "content": { "platform_data": { "geo_data": { "type": "point", "coordinates": { "latitude": 34.393061, "longitude": 132.46012 } }, "location": { "country_code": "US", "url": "https://api.twitter.com/1.1/geo/id/1d9a5370a355ab0c.json", "country": "United States", "place_type": "city", "bounding_box": "", "type": "Polygon", "coordinates": "", "full_name": "Chicago", "name": "Chicago, IL" }, "social_platform_original_url": "https://instagram.com/p/9LrN4iTZNq/" }, "author": { "profile": { "username": "shoreman514", "name": "CSKF: ima K.", "profile_link": "http://instagram.com/shoreman514", "avatar": "https://scontent.cdninstagram.com/t51.2885" }, "platform_id": "2068959963", "social_platform": "instagram", "created_on": "2016", "username": "shoreman514", "id": 18536003 }, "text": "Wtaps Canvas Sneakers, Navy, size medium/US 9. (Fit US 10, narrow 10.5) $150 shipped. #wtaps #wtaps_dailypics #madeinjapan #wtapsforsale #neighborhoodforsale #wtvua #placingthingswheretheyshouldbe #wayoflife #visvim #visvimforsale #visvimgang #biancachandonforsale #biancachandon #palaceskateboards #supremeforsale #supremenyc #acrnm #arcteryxveilance #bronze56k #polarskateco", "social_platform_created_on": "2015", "platform_ref: 1102164603880444778_2068959963": "", "content_state": "active", "social_platform": "instagram", "created_on": "2015", "content_type": "image", "media": { "platform_data": { "url": "https://instagram.com/p/9LrN4iTZNq/" }, "original_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01c.JPEG", "base_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2", "mediatype": "image", "social_platform": "instagram", "media_urls": { "small_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01d.JPEG", "medium_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8f60c1c85527f3c01e.JPEG", "large_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01c.JPEG" }, "id": 42017028 } }, "shortened_permalink": "http://bit.ly/1kzyJ63", "created_on": "2015", "hashtag": { "social_platform": "instagram", "id": 0, "hashtag_text": "arcteryxveilance" }, "featured": false, "configuration": null, "id": 43992816 } ], "namespace": "marketer_tags", "key": "shirts" } } ``` -------------------------------- ### Content Response Sample Source: https://developers.wyng.com/api/content Example response for retrieving content items, including details about UGC items, campaign information, and associated media. ```APIDOC ## Response Example for Content Retrieval ### Description This is an example of a successful response (200 OK) when retrieving content items. It includes pagination information, embedded UGC items with their details, campaign context, and author information. ### Response Example (200 OK) ```json { "total_results": 1, "_embedded": { "ugc:item": [ { "entry_confirmation_sent": false, "approval_status": "pen", "campaign": 16252, "default_activate_unit": { "image_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/560e56c0ef95a64962c14d37/560e56c0ef95a6477eb62eab.JPEG", "name": "Hooded Shell Jacket", "click_through_url": "http://www.futurism.me/products/fitted", "catalog_item": null, "catalog_image_url_src": null, "external_id": null, "id": 1234, "archived": false, "managed": true, "created_on": "2015-10-02T10:12:46Z", "click_unit_library": 420, "last_modified": "2015-10-02T10:12:46Z", "associated_contents": [], "activate_unit_library": 420 }, "submission": null, "content": { "platform_data": { "geo_data": { "type": "point", "coordinates": { "latitude": 34.393061, "longitude": 132.46012 } }, "location": { "country_code": "US", "url": "https://api.twitter.com/1.1/geo/id/1d9a5370a355ab0c.json", "country": "United States", "place_type": "city", "bounding_box": "", "type": "Polygon", "coordinates": "", "full_name": "Chicago", "name": "Chicago, IL" }, "social_platform_original_url": "https://instagram.com/p/9LrN4iTZNq/" }, "author": { "profile": { "username": "shoreman514", "name": "CSKF: ima K.", "profile_link": "http://instagram.com/shoreman514", "avatar": "https://scontent.cdninstagram.com/t51.2885" }, "platform_id": "2068959963", "social_platform": "instagram", "created_on": "2016", "username": "shoreman514", "id": 18536003 }, "text": "Wtaps Canvas Sneakers, Navy, size medium/US 9. (Fit US 10, narrow 10.5) $150 shipped. #wtaps #wtaps_dailypics #madeinjapan #wtapsforsale #neighborhoodforsale #wtvua #placingthingswheretheyshouldbe #wayoflife #visvim #visvimforsale #visvimgang #biancachandonforsale #biancachandon #palaceskateboards #supremeforsale #supremenyc #acrnm #arcteryxveilance #bronze56k #polarskateco", "social_platform_created_on": "2015", "platform_ref: 1102164603880444778_2068959963": "", "content_state": "active", "social_platform": "instagram", "created_on": "2015", "content_type": "image", "media": { "platform_data": { "url": "https://instagram.com/p/9LrN4iTZNq/" }, "original_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01c.JPEG", "base_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2", "mediatype": "image", "social_platform": "instagram", "media_urls": { "small_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01d.JPEG", "medium_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8f60c1c85527f3c01e.JPEG", "large_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01c.JPEG" }, "id": 42017028 } }, "shortened_permalink": "http://bit.ly/1kzyJ63", "created_on": "2015", "hashtag": { "social_platform": "instagram", "id": 0, "hashtag_text": "arcteryxveilance" }, "featured": false, "configuration": null, "id": 43992816 } ] } } ``` ``` -------------------------------- ### Retrieve Tags for UGC Item (API Request Example) Source: https://developers.wyng.com/api/content This example demonstrates how to make an API request to retrieve tags associated with a specific User Generated Content (UGC) item. It requires the UGC ID as a path parameter and an access token as a query parameter. ```curl curl -X GET \ 'https://content-api.wyng.com/v1/tags/ugc/43992816/?access_token=lifUzxEAWau9VBhcqcOkinZtgyqQYe' \ -H 'Accept: application/json' ``` -------------------------------- ### GET /content Source: https://developers.wyng.com/api/content This endpoint retrieves content items from the library. It provides a sample 200 response. ```APIDOC ## GET /content ### Description Retrieves content items from the library. ### Method GET ### Endpoint /content ### Parameters #### Query Parameters - **access_token** (string) - Required - Requires a READ-WRITE access token. ### Response #### Success Response (200) - **total_results** (integer) - Total number of results. - **_embedded** (object) - Embedded content items. - **ugc:item** (array) - Array of content items. - **entry_confirmation_sent** (boolean) - Indicates if entry confirmation was sent. - **approval_status** (string) - Approval status. - **campaign** (integer) - Campaign ID. - **default_activate_unit** (object) - Default activation unit details. - **image_url** (string) - Image URL. - **name** (string) - Name. - **click_through_url** (string) - Click through URL. - **catalog_item** (null) - Catalog item (null). - **catalog_image_url_src** (null) - Catalog image URL source (null). - **external_id** (null) - External ID (null). - **id** (integer) - ID. - **archived** (boolean) - Archived status. - **managed** (boolean) - Managed status. - **created_on** (string) - Creation timestamp. - **click_unit_library** (integer) - Click unit library ID. - **last_modified** (string) - Last modified timestamp. - **associated_contents** (array) - Associated contents (empty array). - **activate_unit_library** (integer) - Activate unit library ID. - **submission** (null) - Submission details (null). - **content** (object) - Content details. - **platform_data** (object) - Platform data. - **geo_data** (object) - Geographic data. - **type** (string) - Type (point). - **coordinates** (object) - Coordinates. - **latitude** (number) - Latitude. - **longitude** (number) - Longitude. - **location** (object) - Location details. - **country_code** (string) - Country code. - **url** (string) - URL. - **country** (string) - Country. - **place_type** (string) - Place type. - **bounding_box** (string) - Bounding box (empty string). - **type** (string) - Type (Polygon). - **coordinates** (string) - Coordinates (empty string). - **full_name** (string) - Full name. - **name** (string) - Name. - **social_platform_original_url** (string) - Social platform original URL. - **author** (object) - Author details. - **profile** (object) - Profile details. - **username** (string) - Username. - **name** (string) - Name. - **profile_link** (string) - Profile link. - **avatar** (string) - Avatar URL. - **platform_id** (string) - Platform ID. - **social_platform** (string) - Social platform. - **created_on** (string) - Creation timestamp. - **username** (string) - Username. - **id** (integer) - ID. - **text** (string) - Content text. - **social_platform_created_on** (string) - Social platform creation timestamp. - **platform_ref: 1102164603880444778_2068959963** (string) - Platform reference. - **content_state** (string) - Content state. - **social_platform** (string) - Social platform. - **created_on** (string) - Creation timestamp. - **content_type** (string) - Content type. - **media** (object) - Media details. - **platform_data** (object) - Platform data. - **url** (string) - URL. - **original_url** (string) - Original URL. - **base_url** (string) - Base URL. - **mediatype** (string) - Media type. - **social_platform** (string) - Social platform. - **media_urls** (object) - Media URLs. - **small_image** (string) - Small image URL. - **medium_image** (string) - Medium image URL. - **large_image** (string) - Large image URL. - **id** (integer) - ID. - **shortened_permalink** (string) - Shortened permalink. - **created_on** (string) - Creation timestamp. - **hashtag** (object) - Hashtag details. - **social_platform** (string) - Social platform. - **id** (integer) - ID. - **hashtag_text** (string) - Hashtag text. - **featured** (boolean) - Featured status. - **configuration** (null) - Configuration (null). - **id** (integer) - ID. #### Response Example ```json { "total_results": 1, "_embedded": { "ugc:item": [ { "entry_confirmation_sent": false, "approval_status": "pen", "campaign": 16252, "default_activate_unit": { "image_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/560e56c0ef95a64962c14d37/560e56c0ef95a6477eb62eab.JPEG", "name": "Hooded Shell Jacket", "click_through_url": "http://www.futurism.me/products/fitted", "catalog_item": null, "catalog_image_url_src": null, "external_id": null, "id": 1234, "archived": false, "managed": true, "created_on": "2015-10-02T10:12:46Z", "click_unit_library": 420, "last_modified": "2015-10-02T10:12:46Z", "associated_contents": [ ], "activate_unit_library": 420 }, "submission": null, "content": { "platform_data": { "geo_data": { "type": "point", "coordinates": { "latitude": 34.393061, "longitude": 132.46012 } }, "location": { "country_code": "US", "url": "https://api.twitter.com/1.1/geo/id/1d9a5370a355ab0c.json", "country": "United States", "place_type": "city", "bounding_box": "", "type": "Polygon", "coordinates": "", "full_name": "Chicago", "name": "Chicago, IL" }, "social_platform_original_url": "https://instagram.com/p/9LrN4iTZNq/" }, "author": { "profile": { "username": "shoreman514", "name": "CSKF: ima K.", "profile_link": "http://instagram.com/shoreman514", "avatar": "https://scontent.cdninstagram.com/t51.2885" }, "platform_id": "2068959963", "social_platform": "instagram", "created_on": "2016", "username": "shoreman514", "id": 18536003 }, "text": "Wtaps Canvas Sneakers, Navy, size medium/US 9. (Fit US 10, narrow 10.5) $150 shipped. #wtaps #wtaps_dailypics #madeinjapan #wtapsforsale #neighborhoodforsale #wtvua #placingthingswheretheyshouldbe #wayoflife #visvim #visvimforsale #visvimgang #biancachandonforsale #biancachandon #palaceskateboards #supremeforsale #supremenyc #acrnm #arcteryxveilance #bronze56k #polarskateco", "social_platform_created_on": "2015", "platform_ref: 1102164603880444778_2068959963": "", "content_state": "active", "social_platform": "instagram", "created_on": "2015", "content_type": "image", "media": { "platform_data": { "url": "https://instagram.com/p/9LrN4iTZNq/" }, "original_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01c.JPEG", "base_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2", "mediatype": "image", "social_platform": "instagram", "media_urls": { "small_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01d.JPEG", "medium_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8f60c1c85527f3c01e.JPEG", "large_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01c.JPEG" }, "id": 42017028 } }, "shortened_permalink": "http://bit.ly/1kzyJ63", "created_on": "2015", "hashtag": { "social_platform": "instagram", "id": 0, "hashtag_text": "arcteryxveilance" }, "featured": false, "configuration": null, "id": 43992816 } ] } } ``` ``` -------------------------------- ### GET /v1/activate_units/ Source: https://developers.wyng.com/api/content Retrieves a list of activate units. This endpoint is intended for content management and low-volume use cases. For high-volume scenarios, consider using /v2/content/items or /v2/content/filters. ```APIDOC ## GET /v1/activate_units/ ### Description Retrieves a list of activate units. This endpoint is intended for content management and low-volume use cases. For high-volume scenarios, consider using /v2/content/items or /v2/content/filters. ### Method GET ### Endpoint /v1/activate_units/ ### Parameters #### Query Parameters - **access_token** (string) - Required - Your access token for authentication. ### Response #### Success Response (200) - **total_results** (integer) - The total number of results found. - **_embedded** (object) - Contains the list of activate unit items. - **activate_unit:item** (array) - An array of activate unit objects. - **image_url** (string) - The URL of the image associated with the activate unit. - **name** (string) - The name of the activate unit. - **click_through_url** (string) - The URL to redirect to when the unit is clicked. - **catalog_item** (any) - Information about the catalog item, if applicable. - **catalog_image_url_src** (any) - Source URL for the catalog image. - **external_id** (any) - External identifier for the item. - **id** (integer) - The unique identifier for the activate unit. - **archived** (boolean) - Indicates if the unit is archived. - **managed** (boolean) - Indicates if the unit is managed. - **created_on** (string) - Timestamp of when the unit was created (ISO 8601 format). - **click_unit_library** (integer) - Identifier for the click unit library. - **last_modified** (string) - Timestamp of the last modification (ISO 8601 format). - **associated_contents** (array) - List of associated content. - **activate_unit_library** (integer) - Identifier for the activate unit library. ### Response Example ```json { "total_results": 1, "_embedded": { "activate_unit:item": [ { "image_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/560e56c0ef95a64962c14d37/560e56c0ef95a6477eb62eab.JPEG", "name": "Hooded Shell Jacket", "click_through_url": "http://www.futurism.me/products/fitted", "catalog_item": null, "catalog_image_url_src": null, "external_id": null, "id": 1234, "archived": false, "managed": true, "created_on": "2015-10-02T10:12:46Z", "click_unit_library": 420, "last_modified": "2015-10-02T10:12:46Z", "associated_contents": [], "activate_unit_library": 420 } ] } } ``` ``` -------------------------------- ### GET /websites/developers_wyng_api Source: https://developers.wyng.com/api/content Retrieves a list of UGC items associated with a campaign, including details about the submission, author, and content. ```APIDOC ## GET /websites/developers_wyng_api ### Description Retrieves a list of user-generated content (UGC) items submitted to a campaign. The response includes details such as submission status, campaign information, author profiles, content data (including social platform details and media URLs), and associated hashtags. ### Method GET ### Endpoint /websites/developers_wyng_api ### Query Parameters * **campaign_id** (integer) - Required - The ID of the campaign to retrieve UGC items from. ### Request Example ``` GET /websites/developers_wyng_api?campaign_id=16252 ``` ### Response #### Success Response (200) - **total_results** (integer) - The total number of UGC items found. - **_embedded** (object) - Contains the list of UGC items. - **ugc:item** (array) - An array of UGC item objects. - **entry_confirmation_sent** (boolean) - Indicates if an entry confirmation was sent. - **approval_status** (string) - The approval status of the UGC item (e.g., 'pen', 'approved'). - **campaign** (integer) - The ID of the campaign associated with the UGC item. - **default_activate_unit** (object) - Details of the default activation unit. - **submission** (object) - Information about the submission (can be null). - **content** (object) - Detailed information about the submitted content. - **platform_data** (object) - Platform-specific data for the content. - **author** (object) - Information about the content author. - **text** (string) - The text content submitted. - **social_platform_created_on** (string) - Creation timestamp on the social platform. - **platform_ref: [ID]_[UserID]** (string) - Platform-specific reference ID. - **content_state** (string) - The state of the content (e.g., 'active'). - **social_platform** (string) - The social platform where the content originated. - **created_on** (string) - Creation timestamp of the UGC item. - **content_type** (string) - The type of content (e.g., 'image'). - **media** (object) - Information about the media associated with the content. - **shortened_permalink** (string) - A shortened URL for the UGC item. - **created_on** (string) - Creation timestamp of the UGC item. - **hashtag** (object) - Information about the hashtag associated with the UGC item. - **featured** (boolean) - Indicates if the UGC item is featured. - **configuration** (object) - Configuration details (can be null). - **id** (integer) - The unique ID of the UGC item. #### Response Example ```json { "total_results": 1, "_embedded": { "ugc:item": [ { "entry_confirmation_sent": false, "approval_status": "pen", "campaign": 16252, "default_activate_unit": { "image_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/560e56c0ef95a64962c14d37/560e56c0ef95a6477eb62eab.JPEG", "name": "Hooded Shell Jacket", "click_through_url": "http://www.futurism.me/products/fitted", "catalog_item": null, "catalog_image_url_src": null, "external_id": null, "id": 1234, "archived": false, "managed": true, "created_on": "2015-10-02T10:12:46Z", "click_unit_library": 420, "last_modified": "2015-10-02T10:12:46Z", "associated_contents": [], "activate_unit_library": 420 }, "submission": null, "content": { "platform_data": { "geo_data": { "type": "point", "coordinates": { "latitude": 34.393061, "longitude": 132.46012 } }, "location": { "country_code": "US", "url": "https://api.twitter.com/1.1/geo/id/1d9a5370a355ab0c.json", "country": "United States", "place_type": "city", "bounding_box": "", "type": "Polygon", "coordinates": "", "full_name": "Chicago", "name": "Chicago, IL" }, "social_platform_original_url": "https://instagram.com/p/9LrN4iTZNq/" }, "author": { "profile": { "username": "shoreman514", "name": "CSKF: ima K.", "profile_link": "http://instagram.com/shoreman514", "avatar": "https://scontent.cdninstagram.com/t51.2885" }, "platform_id": "2068959963", "social_platform": "instagram", "created_on": "2016", "username": "shoreman514", "id": 18536003 }, "text": "Wtaps Canvas Sneakers, Navy, size medium/US 9. (Fit US 10, narrow 10.5) $150 shipped. #wtaps #wtaps_dailypics #madeinjapan #wtapsforsale #neighborhoodforsale #wtvua #placingthingswheretheyshouldbe #wayoflife #visvim #visvimforsale #visvimgang #biancachandonforsale #biancachandon #palaceskateboards #supremeforsale #supremenyc #acrnm #arcteryxveilance #bronze56k #polarskateco", "social_platform_created_on": "2015", "platform_ref: 1102164603880444778_2068959963": "", "content_state": "active", "social_platform": "instagram", "created_on": "2015", "content_type": "image", "media": { "platform_data": { "url": "https://instagram.com/p/9LrN4iTZNq/" }, "original_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01c.JPEG", "base_url": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2", "mediatype": "image", "social_platform": "instagram", "media_urls": { "small_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01d.JPEG", "medium_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8f60c1c85527f3c01e.JPEG", "large_image": "https://s3.amazonaws.com/com.wyng.services.media/images/media/54ac3103ef95a67c1cff8ef2/562a3b8e60c1c85527f3c01c.JPEG" }, "id": 42017028 } }, "shortened_permalink": "http://bit.ly/1kzyJ63", "created_on": "2015", "hashtag": { "social_platform": "instagram", "id": 0, "hashtag_text": "arcteryxveilance" }, "featured": false, "configuration": null, "id": 43992816 } ] } } ``` ``` -------------------------------- ### GET /v1/tags/{namespace}/{key}/ Source: https://developers.wyng.com/api/content Retrieves information about a specific tag, including a list of content items associated with it. Note: This endpoint is intended for content management and low-volume use cases. ```APIDOC ## GET /v1/tags/{namespace}/{key}/ ### Description Retrieves information about a specific tag, including a list of content items associated with it. Note: This endpoint is intended for content management and low-volume use cases. ### Method GET ### Endpoint https://content-api.wyng.com/v1/tags/{namespace}/{key}/ ### Parameters #### Path Parameters - **namespace** (string) - Required - Example: `marketer_tags`. Tag namespace. - **key** (string) - Required - Example: `shirt`. Tag key. #### Query Parameters - **access_token** (string) - Required - Example: `access_token=lifUzxEAWau9VBhcqcOkinZtgyqQYe`. ### Response #### Success Response (200) OK #### Response Example (No specific example provided in the source text, but it would typically return tag details and a list of associated UGC item IDs.) ``` -------------------------------- ### Get Tag Information using Wyng API Source: https://developers.wyng.com/api/content This snippet shows how to retrieve information about a specific tag, including a list of content items associated with it. It requires the tag's namespace and key. Note that this endpoint is intended for low-volume use cases like content management. ```bash GET /v1/tags/{namespace}/{key}/?access_token=YOUR_ACCESS_TOKEN ``` -------------------------------- ### POST /v2/content/ Source: https://developers.wyng.com/api/content Creates a new content item, such as an image, video, or text post. It allows for detailed specifications including URLs, captions, submission details, tags, author information, and approval status. ```APIDOC ## POST /v2/content/ ### Description Creates a new content item, such as an image, video, or text post. It allows for detailed specifications including URLs, captions, submission details, tags, author information, and approval status. ### Method POST ### Endpoint https://content-api.wyng.com/v2/content/ ### Parameters #### Request Body - **content_url** (string) - Optional - URL to the image or video. Required if `ugc_type` is not "text". - **video_thumbnail** (string) - Required if content type is video. - **content_type** (string) - Required - Enum: "image", "video", "text". Type of uploaded content. - **caption** (string) - Required if `ugc_type` is "text". - **content_ref** (string) - Required if `ugc_type` is "text". - **submission** (object) - Optional - An object to store fields from a submission form used to upload the content. This data is assumed to contain PII and will only be returned to API calls using READ-WRITE tokens. If a username and email are provided, an author will be derived if it is not explicit. - **username** (string) - Username for submission. - **email** (string) - Email for submission. - **additionalField** (string) - Any additional field for submission. - **tags** (object) - Optional - Object for tagging content. - **hashtags** (array of strings) - List of hashtags. - **marketer_tags** (array of strings) - List of marketer tags. - **other_namespace** (array of strings) - List of tags in another namespace. - **author** (object) - Optional - Author data, ignored if `submission` is specified. - **username** (string) - Username of the author. - **author_ref** (string) - Reference ID of the author. - **approval_status** (string) - Optional - Default: "pen". Enum: "app", "rej", "pen". Approval status of the content (`Approved`, `Rejected` or `Pending`). ### Request Example ```json { "content_url": "https://example.com/cat.jpg", "video_thumbnail": "https://example.com/cat.jpg", "content_type": "image", "caption": "My cute cat", "content_ref": "My cute cat", "submission": { "username": "TheRealDeal", "email": "the.real.deal@example.com", "additionalField": "value" }, "tags": { "hashtags": [ "cat", "cute" ], "marketer_tags": [ "kitten", "animals" ], "other_namespace": [ "kitten", "animals" ] }, "author": { "username": "TheRealDeal", "author_ref": "123456" }, "approval_status": "app" } ``` ### Response #### Success Response (201) Created #### Response Example (No specific example provided in the source text, but it would typically return the created content object with an ID.) #### Error Responses - **400** Bad Request - **422** Unprocessable Entity ``` -------------------------------- ### Create Content using Wyng API Source: https://developers.wyng.com/api/content This snippet demonstrates how to create content items (images, videos, text) using the Wyng API. It includes optional fields for video thumbnails, captions, submission details, tags, author information, and approval status. Ensure you have a READ-WRITE access token for creation. ```json { "content_url": "https://example.com/cat.jpg", "video_thumbnail": "https://example.com/cat.jpg", "content_type": "image", "caption": "My cute cat", "content_ref": "My cute cat", "submission": { "username": "TheRealDeal", "email": "the.real.deal@example.com", "additionalField": "value" }, "tags": { "hashtags": [ "cat", "cute" ], "marketer_tags": [ "kitten", "animals" ], "other_namespace": [ "kitten", "animals" ] }, "author": { "username": "TheRealDeal", "author_ref": "123456" }, "approval_status": "app" } ``` -------------------------------- ### POST /content Source: https://developers.wyng.com/api/content Adds a content item to the library. Requires a READ-WRITE access token. ```APIDOC ## POST /content ### Description Adds a content item to library. ### Method POST ### Endpoint /content ### Parameters #### Query Parameters - **access_token** (string) - Required - Requires a READ-WRITE access token. ``` -------------------------------- ### GET /v2/content/filters/{filter_uuid} Source: https://developers.wyng.com/api/content Retrieves content filters based on the provided filter_uuid and query parameters. ```APIDOC ## GET /v2/content/filters/{filter_uuid} ### Description Retrieves content filters based on the provided filter_uuid and query parameters. This endpoint allows for advanced filtering, sorting, and prioritization of content items. ### Method GET ### Endpoint `/v2/content/filters/{filter_uuid}` ### Parameters #### Path Parameters - **filter_uuid** (string) - Required - The unique identifier for the filter. #### Query Parameters - **access_token** (string) - Required - Requires a READ-WRITE access token. Example: `access_token=lifUzxEAWau9VBhcqcOkinZtgyqQYe` - **page** (number) - Optional - Specifies the starting point in a stream of results. Example: `page=1` - **page_size** (number) - Optional - Defines the number of results to return per request. Defaults to 50. Example: `page_size=3` - **info** (number) - Optional - If set to 1, returns data about the filter itself, not the content. Example: `info=1` - **seed** (number) - Optional - Used as a seed for random sorting. Only relevant if `sort_by` is set to `random`. Example: `seed=19` - **sort_by** (string) - Optional - Overrides the default sort order. Example: `sort_by=created_on:desc` - **favorite_tag** (string) - Optional - Prioritizes content items with a specific tag, boosting them to the top of the results. Any `sort_by` parameter will act as a secondary sort. Example: `favorite_tag=star-ugc` - **additional_query** (string) - Optional - Appends additional criteria to the filter query using an AND operator. Example: `additional_query=approval_status:app` ### Request Example ``` GET https://content-api.wyng.com/v2/content/filters/{filter_uuid}?access_token=YOUR_ACCESS_TOKEN&page=1&page_size=10 ``` ### Response #### Success Response (200) OK #### Response Example (Response structure depends on the specific filter and query parameters. Typically includes a list of content items with their associated data.) ```json { "data": [ { "content_id": "xyz123", "title": "Sample Content", "created_at": "2023-10-27T10:00:00Z" } ], "pagination": { "next_page": null } } ``` ```