API / Ads
An Ad represents promotional content that can be inserted into a Feed at specified positions.
List Ads / Custom Posts
This endpoint lists all Ads / Custom Posts
Request
Optional Parameters
feed_id
Show sources for a particular Feed
Response
[ { "id": "xkql7nr4", "feed_id": "a2232619-9d95-430f-9956-21343838e528", "network_id": 3, "status": "paused", "name": "custom", "title": "", "text": "this is a text", "is_html": 0, "click_action": "goto-url", "position_start": 1, "position_repeats": true, "position_repeat_interval": 5, "image_width": 5, "image_height": 5, "url": "http://google.com", "created_at": "2022-02-07 04:40:30", "slug": "xkql7nr4", "network_name": "Facebook", "image_url": "https://curator-prod.s3.amazonaws.com/custom-post-assets/208/GimxjaMS.jpg", "video_url": "https://my-video-url/cool.mp4" } ]
List Ads / Custom Posts
This endpoint lists all Ads / Custom Posts
Request
Optional Parameters
feed_id
Show sources for a particular Feed
Response
[ { "id": "xkql7nr4", "feed_id": "a2232619-9d95-430f-9956-21343838e528", "network_id": 3, "status": "paused", "name": "custom", "title": "", "text": "this is a text", "is_html": 0, "click_action": "goto-url", "position_start": 1, "position_repeats": true, "position_repeat_interval": 5, "image_width": 5, "image_height": 5, "url": "http://google.com", "created_at": "2022-02-07 04:40:30", "slug": "xkql7nr4", "network_name": "Facebook", "image_url": "https://curator-prod.s3.amazonaws.com/custom-post-assets/208/GimxjaMS.jpg", "video_url": "https://my-video-url/cool.mp4" } ]
List Ads / Custom Posts
This endpoint lists all Ads / Custom Posts
Request
Optional Parameters
feed_id
Show sources for a particular Feed
Response
[ { "id": "xkql7nr4", "feed_id": "a2232619-9d95-430f-9956-21343838e528", "network_id": 3, "status": "paused", "name": "custom", "title": "", "text": "this is a text", "is_html": 0, "click_action": "goto-url", "position_start": 1, "position_repeats": true, "position_repeat_interval": 5, "image_width": 5, "image_height": 5, "url": "http://google.com", "created_at": "2022-02-07 04:40:30", "slug": "xkql7nr4", "network_name": "Facebook", "image_url": "https://curator-prod.s3.amazonaws.com/custom-post-assets/208/GimxjaMS.jpg", "video_url": "https://my-video-url/cool.mp4" } ]
Create Ad / Custom Post
This end point creates an Ad / Custom Post for a Feed.
Request
POST /v1.2/ads
{
"name" : "Awesome Ad!",
"feed_id" : "a2232619-9d95-430f-9956-21343838e528",
"network_icon" : 1,
"position_start" : 4,
"position_repeats" : true,
"position_repeat_interval" : 10,
"network_id" : 3,
"text" : "this is a text",
"status" : "paused",
"click_action" : "goto-url",
"url" : "http://google.com",
"image_url": "https://curator-stage.s3.amazonaws.com/custom-post-assets/208/GimxjaMS.jpg",
"video_url": "https://my-video-url/cool.mp4"
Required Parameters
feed_id
Feed to assign the Ad to
network_id
Network to assign the Ad. See Network
name
The name of the Ad
position_start
The position placement of the Ad
position_repeats
Whether the Ad position repeats (value: true OR false)
position_repeat_interval
The number when this Ad will repeat on every post. (Required if position_repeats is true)
text
The text of the Ad
status
One of: active = the Ad will run and will be shown in the Feed, paused = the Ad will not run and will not be shown in the Feed.
click_action
one of: goto-url = when user clicks on the Ad, it will be redirected to the URL that you specified in the url field. nothing = When the user clicks on the Ad, nothing will happen.
Optional Parameters
url
The URL that the user will be redirected when they clicked on the Ad.
if click_action = goto-url
image_urlThe Image URL of the Ad that is hosted by an external URL.
video_urlThe Video URL of the Ad that is hosted by an external URL.
Response
{ "id": "2gq9pjnk", "feed_id": "a2232619-9d95-430f-9956-21343838e528", "network_id": 3, "status": "paused", "name": "Awesome Ad!", "title": "", "text": "this is a text", "is_html": 0, "click_action": "goto-url", "position_start": 4, "position_repeats": true, "position_repeat_interval": 10, "image_width": 5, "image_height": 5, "url": "http://google.com", "created_at": "2022-02-08 02:34:53", "feed": { "id": "a2232619-9d95-430f-9956-21343838e528", "public_key": "d926da1c-1dab-44a7-87f5-89496374c14a", "moderation": "post", "post_status": 1, "name": "Default feed", "type": "website", "widget_type": "Waterfall", "widget_theme": "sydney", "slug": "curator-feed", "widget_options": "{\"type\":\"Waterfall\"}", "widget_styles": "{}", "widget_colours": "{}", "widget_advanced_styles": 0, "colour_options": null, "default_image": null, "default_user_image": null, "api_id": "a2232619-9d95-430f-9956-21343838e528", "widget_endpoint": null, "debug": 0, "widget_version": "4.0", "js_loader_version": "2", "html_before": null, "html_after": null, "cache": 1, "cache_time": "5", "default_feed_layout_id": 644, "post_count": 811, "is_installed": 1, "meta": { "embedSource": "wordpress-plugin", "hasTiktokEmbed": true }, "is_latest_version": false }, "slug": "2gq9pjnk", "network_name": "Facebook", "image_url": "https://image-url.jpg", "video_url": "https://video-url.mp4" }
Create Ad / Custom Post
This end point creates an Ad / Custom Post for a Feed.
Request
POST /v1.2/ads
{
"name" : "Awesome Ad!",
"feed_id" : "a2232619-9d95-430f-9956-21343838e528",
"network_icon" : 1,
"position_start" : 4,
"position_repeats" : true,
"position_repeat_interval" : 10,
"network_id" : 3,
"text" : "this is a text",
"status" : "paused",
"click_action" : "goto-url",
"url" : "http://google.com",
"image_url": "https://curator-stage.s3.amazonaws.com/custom-post-assets/208/GimxjaMS.jpg",
"video_url": "https://my-video-url/cool.mp4"
Required Parameters
feed_id
Feed to assign the Ad to
network_id
Network to assign the Ad. See Network
name
The name of the Ad
position_start
The position placement of the Ad
position_repeats
Whether the Ad position repeats (value: true OR false)
position_repeat_interval
The number when this Ad will repeat on every post. (Required if position_repeats is true)
text
The text of the Ad
status
One of: active = the Ad will run and will be shown in the Feed, paused = the Ad will not run and will not be shown in the Feed.
click_action
one of: goto-url = when user clicks on the Ad, it will be redirected to the URL that you specified in the url field. nothing = When the user clicks on the Ad, nothing will happen.
Optional Parameters
url
The URL that the user will be redirected when they clicked on the Ad.
if click_action = goto-url
image_urlThe Image URL of the Ad that is hosted by an external URL.
video_urlThe Video URL of the Ad that is hosted by an external URL.
Response
{ "id": "2gq9pjnk", "feed_id": "a2232619-9d95-430f-9956-21343838e528", "network_id": 3, "status": "paused", "name": "Awesome Ad!", "title": "", "text": "this is a text", "is_html": 0, "click_action": "goto-url", "position_start": 4, "position_repeats": true, "position_repeat_interval": 10, "image_width": 5, "image_height": 5, "url": "http://google.com", "created_at": "2022-02-08 02:34:53", "feed": { "id": "a2232619-9d95-430f-9956-21343838e528", "public_key": "d926da1c-1dab-44a7-87f5-89496374c14a", "moderation": "post", "post_status": 1, "name": "Default feed", "type": "website", "widget_type": "Waterfall", "widget_theme": "sydney", "slug": "curator-feed", "widget_options": "{\"type\":\"Waterfall\"}", "widget_styles": "{}", "widget_colours": "{}", "widget_advanced_styles": 0, "colour_options": null, "default_image": null, "default_user_image": null, "api_id": "a2232619-9d95-430f-9956-21343838e528", "widget_endpoint": null, "debug": 0, "widget_version": "4.0", "js_loader_version": "2", "html_before": null, "html_after": null, "cache": 1, "cache_time": "5", "default_feed_layout_id": 644, "post_count": 811, "is_installed": 1, "meta": { "embedSource": "wordpress-plugin", "hasTiktokEmbed": true }, "is_latest_version": false }, "slug": "2gq9pjnk", "network_name": "Facebook", "image_url": "https://image-url.jpg", "video_url": "https://video-url.mp4" }
Create Ad / Custom Post
This end point creates an Ad / Custom Post for a Feed.
Request
POST /v1.2/ads
{
"name" : "Awesome Ad!",
"feed_id" : "a2232619-9d95-430f-9956-21343838e528",
"network_icon" : 1,
"position_start" : 4,
"position_repeats" : true,
"position_repeat_interval" : 10,
"network_id" : 3,
"text" : "this is a text",
"status" : "paused",
"click_action" : "goto-url",
"url" : "http://google.com",
"image_url": "https://curator-stage.s3.amazonaws.com/custom-post-assets/208/GimxjaMS.jpg",
"video_url": "https://my-video-url/cool.mp4"
Required Parameters
feed_id
Feed to assign the Ad to
network_id
Network to assign the Ad. See Network
name
The name of the Ad
position_start
The position placement of the Ad
position_repeats
Whether the Ad position repeats (value: true OR false)
position_repeat_interval
The number when this Ad will repeat on every post. (Required if position_repeats is true)
text
The text of the Ad
status
One of: active = the Ad will run and will be shown in the Feed, paused = the Ad will not run and will not be shown in the Feed.
click_action
one of: goto-url = when user clicks on the Ad, it will be redirected to the URL that you specified in the url field. nothing = When the user clicks on the Ad, nothing will happen.
Optional Parameters
url
The URL that the user will be redirected when they clicked on the Ad.
if click_action = goto-url
image_urlThe Image URL of the Ad that is hosted by an external URL.
video_urlThe Video URL of the Ad that is hosted by an external URL.
Response
{ "id": "2gq9pjnk", "feed_id": "a2232619-9d95-430f-9956-21343838e528", "network_id": 3, "status": "paused", "name": "Awesome Ad!", "title": "", "text": "this is a text", "is_html": 0, "click_action": "goto-url", "position_start": 4, "position_repeats": true, "position_repeat_interval": 10, "image_width": 5, "image_height": 5, "url": "http://google.com", "created_at": "2022-02-08 02:34:53", "feed": { "id": "a2232619-9d95-430f-9956-21343838e528", "public_key": "d926da1c-1dab-44a7-87f5-89496374c14a", "moderation": "post", "post_status": 1, "name": "Default feed", "type": "website", "widget_type": "Waterfall", "widget_theme": "sydney", "slug": "curator-feed", "widget_options": "{\"type\":\"Waterfall\"}", "widget_styles": "{}", "widget_colours": "{}", "widget_advanced_styles": 0, "colour_options": null, "default_image": null, "default_user_image": null, "api_id": "a2232619-9d95-430f-9956-21343838e528", "widget_endpoint": null, "debug": 0, "widget_version": "4.0", "js_loader_version": "2", "html_before": null, "html_after": null, "cache": 1, "cache_time": "5", "default_feed_layout_id": 644, "post_count": 811, "is_installed": 1, "meta": { "embedSource": "wordpress-plugin", "hasTiktokEmbed": true }, "is_latest_version": false }, "slug": "2gq9pjnk", "network_name": "Facebook", "image_url": "https://image-url.jpg", "video_url": "https://video-url.mp4" }
Update Ad / Custom Post
This end point creates an Ad / Custom Post for a Feed.
Request
POST /v1.2/ads/AD_ID
{
"name" : "Awesome Ad!",
"feed_id" : "a2232619-9d95-430f-9956-21343838e528",
"position_start" : 2,
"position_repeats" : false,
"network_id" : 5,
"text" : "this is a text",
"status" : "active",
"click_action" : "goto-url",
"url" : "http://google.com"
Required Parameters
AD_ID
ID of the Ad to update
feed_id
Feed to assign the Ad to
network_id
Network to assign the Ad. See Network
name
The name of the Ad
position_start
The position placement of the Ad
position_repeats
Whether the Ad position repeats (value: true OR false)
position_repeat_interval
The number when this Ad will repeat on every post. (Required if position_repeats is true)
text
The text of the Ad
status
One of: active = the Ad will run and will be shown in the Feed, paused = the Ad will not run and will not be shown in the Feed.
click_action
one of: goto-url = when user clicks on the Ad, it will be redirected to the URL that you specified in the url field. nothing = When the user clicks on the Ad, nothing will happen.
Optional Parameters
url
The URL that the user will be redirected when they clicked on the Ad.
if click_action = goto-url
image_urlThe Image URL of the Ad that is hosted by an external URL.
video_urlThe Video URL of the Ad that is hosted by an external URL.
Response
{ "id": "kg3gp13j", "company_id": 208, "feed_id": 642, "network_id": 5, "status": "active", "name": "Awesome Ad!", "title": "", "text": "this is a text", "is_html": 0, "click_action": "goto-url", "position_start": 2, "position_repeats": false, "position_repeat_interval": 3, "image_width": 5, "image_height": 5, "url": "http://google.com", "created_at": "2022-02-08 02:29:50", "updated_at": "2022-02-08 03:07:39", "deleted_at": null, "feed": { "id": "a2232619-9d95-430f-9956-21343838e528", "public_key": "d926da1c-1dab-44a7-87f5-89496374c14a", "moderation": "post", "post_status": 1, "name": "Default feed", "type": "website", "widget_type": "Waterfall", "widget_theme": "sydney", "slug": "curator-feed", "widget_options": "{\"type\":\"Waterfall\"}", "widget_styles": "{}", "widget_colours": "{}", "widget_advanced_styles": 0, "colour_options": null, "default_image": null, "default_user_image": null, "api_id": "a2232619-9d95-430f-9956-21343838e528", "widget_endpoint": null, "debug": 0, "widget_version": "4.0", "js_loader_version": "2", "html_before": null, "html_after": null, "cache": 1, "cache_time": "5", "default_feed_layout_id": 644, "post_count": 812, "is_installed": 1, "meta": { "embedSource": "wordpress-plugin", "hasTiktokEmbed": true }, "is_latest_version": false }, "slug": "kg3gp13j", "network_name": "Google Plus", "image_url": "", "video_url": "" }
Update Ad / Custom Post
This end point creates an Ad / Custom Post for a Feed.
Request
POST /v1.2/ads/AD_ID
{
"name" : "Awesome Ad!",
"feed_id" : "a2232619-9d95-430f-9956-21343838e528",
"position_start" : 2,
"position_repeats" : false,
"network_id" : 5,
"text" : "this is a text",
"status" : "active",
"click_action" : "goto-url",
"url" : "http://google.com"
Required Parameters
AD_ID
ID of the Ad to update
feed_id
Feed to assign the Ad to
network_id
Network to assign the Ad. See Network
name
The name of the Ad
position_start
The position placement of the Ad
position_repeats
Whether the Ad position repeats (value: true OR false)
position_repeat_interval
The number when this Ad will repeat on every post. (Required if position_repeats is true)
text
The text of the Ad
status
One of: active = the Ad will run and will be shown in the Feed, paused = the Ad will not run and will not be shown in the Feed.
click_action
one of: goto-url = when user clicks on the Ad, it will be redirected to the URL that you specified in the url field. nothing = When the user clicks on the Ad, nothing will happen.
Optional Parameters
url
The URL that the user will be redirected when they clicked on the Ad.
if click_action = goto-url
image_urlThe Image URL of the Ad that is hosted by an external URL.
video_urlThe Video URL of the Ad that is hosted by an external URL.
Response
{ "id": "kg3gp13j", "company_id": 208, "feed_id": 642, "network_id": 5, "status": "active", "name": "Awesome Ad!", "title": "", "text": "this is a text", "is_html": 0, "click_action": "goto-url", "position_start": 2, "position_repeats": false, "position_repeat_interval": 3, "image_width": 5, "image_height": 5, "url": "http://google.com", "created_at": "2022-02-08 02:29:50", "updated_at": "2022-02-08 03:07:39", "deleted_at": null, "feed": { "id": "a2232619-9d95-430f-9956-21343838e528", "public_key": "d926da1c-1dab-44a7-87f5-89496374c14a", "moderation": "post", "post_status": 1, "name": "Default feed", "type": "website", "widget_type": "Waterfall", "widget_theme": "sydney", "slug": "curator-feed", "widget_options": "{\"type\":\"Waterfall\"}", "widget_styles": "{}", "widget_colours": "{}", "widget_advanced_styles": 0, "colour_options": null, "default_image": null, "default_user_image": null, "api_id": "a2232619-9d95-430f-9956-21343838e528", "widget_endpoint": null, "debug": 0, "widget_version": "4.0", "js_loader_version": "2", "html_before": null, "html_after": null, "cache": 1, "cache_time": "5", "default_feed_layout_id": 644, "post_count": 812, "is_installed": 1, "meta": { "embedSource": "wordpress-plugin", "hasTiktokEmbed": true }, "is_latest_version": false }, "slug": "kg3gp13j", "network_name": "Google Plus", "image_url": "", "video_url": "" }
Update Ad / Custom Post
This end point creates an Ad / Custom Post for a Feed.
Request
POST /v1.2/ads/AD_ID
{
"name" : "Awesome Ad!",
"feed_id" : "a2232619-9d95-430f-9956-21343838e528",
"position_start" : 2,
"position_repeats" : false,
"network_id" : 5,
"text" : "this is a text",
"status" : "active",
"click_action" : "goto-url",
"url" : "http://google.com"
Required Parameters
AD_ID
ID of the Ad to update
feed_id
Feed to assign the Ad to
network_id
Network to assign the Ad. See Network
name
The name of the Ad
position_start
The position placement of the Ad
position_repeats
Whether the Ad position repeats (value: true OR false)
position_repeat_interval
The number when this Ad will repeat on every post. (Required if position_repeats is true)
text
The text of the Ad
status
One of: active = the Ad will run and will be shown in the Feed, paused = the Ad will not run and will not be shown in the Feed.
click_action
one of: goto-url = when user clicks on the Ad, it will be redirected to the URL that you specified in the url field. nothing = When the user clicks on the Ad, nothing will happen.
Optional Parameters
url
The URL that the user will be redirected when they clicked on the Ad.
if click_action = goto-url
image_urlThe Image URL of the Ad that is hosted by an external URL.
video_urlThe Video URL of the Ad that is hosted by an external URL.
Response
{ "id": "kg3gp13j", "company_id": 208, "feed_id": 642, "network_id": 5, "status": "active", "name": "Awesome Ad!", "title": "", "text": "this is a text", "is_html": 0, "click_action": "goto-url", "position_start": 2, "position_repeats": false, "position_repeat_interval": 3, "image_width": 5, "image_height": 5, "url": "http://google.com", "created_at": "2022-02-08 02:29:50", "updated_at": "2022-02-08 03:07:39", "deleted_at": null, "feed": { "id": "a2232619-9d95-430f-9956-21343838e528", "public_key": "d926da1c-1dab-44a7-87f5-89496374c14a", "moderation": "post", "post_status": 1, "name": "Default feed", "type": "website", "widget_type": "Waterfall", "widget_theme": "sydney", "slug": "curator-feed", "widget_options": "{\"type\":\"Waterfall\"}", "widget_styles": "{}", "widget_colours": "{}", "widget_advanced_styles": 0, "colour_options": null, "default_image": null, "default_user_image": null, "api_id": "a2232619-9d95-430f-9956-21343838e528", "widget_endpoint": null, "debug": 0, "widget_version": "4.0", "js_loader_version": "2", "html_before": null, "html_after": null, "cache": 1, "cache_time": "5", "default_feed_layout_id": 644, "post_count": 812, "is_installed": 1, "meta": { "embedSource": "wordpress-plugin", "hasTiktokEmbed": true }, "is_latest_version": false }, "slug": "kg3gp13j", "network_name": "Google Plus", "image_url": "", "video_url": "" }
Delete Ad / Custom Post
This end point creates an Ad / Custom Post for a Feed.
Request
Required Parameters
AD_ID
ID of the Ad to update
Response
{ "success":t rue, "message":" Ad deleted" }
Delete Ad / Custom Post
This end point creates an Ad / Custom Post for a Feed.
Request
Required Parameters
AD_ID
ID of the Ad to update
Response
{ "success":t rue, "message":" Ad deleted" }
Delete Ad / Custom Post
This end point creates an Ad / Custom Post for a Feed.
Request
Required Parameters
AD_ID
ID of the Ad to update
Response
{ "success":t rue, "message":" Ad deleted" }