Backlinks
Create a Backlink
Creates a new backlink.
Arguments
campaign_id required integer (32) | The ID of the campaign which the backlink belongs to |
title required string | The title of the link |
url required string | The url which contains the backlink |
status required string | Current status of the link, may be either |
date_published required date | The date at which the link was published |
link_type string | The type of link |
target_anchor string | The text of the target anchor |
target_url string | The url of the target |
notes string | A small note that can be used to help describe the backlink. For example "Wrote article on NewsBuzz" |
Endpoint
POST /v3/backlinks
Response
{ "metadata": { "total_pages": 1, "total_records": 1 }, "data": { "id": 1, "title": "test", "status": "published", "date_created": "2018-11-07", "date_published": "2018-11-07", "url": "http://www.test.com/links.html", "link_type": "Blog", "target_anchor": "Click here", "target_url": "http://example.com/article", "notes": "Wrote article on NewsBuzz.", "campaign_id": 1234, "domain_authority": 0, "page_authority": 0 } }
Retrieve a Backlink
Retrieves an existing backlink with the given id.
Arguments
id required integer (32) | The ID of the backlink to retrieve. |
Endpoint
GET /v3/backlinks/:id
Response
{ "metadata": { "total_pages": 1, "total_records": 1 }, "data": { "id": 1, "date_created": "2018-11-07", "date_published": "2018-11-07", "title": "test", "url": "http://www.test.com", "status": "published", "link_type": "Links Page", "target_anchor": "Click here", "target_url": "http://example.com/article", "notes": "Wrote article on NewsBuzz.", "domain_authority": 0, "page_authority": 0 } }
Update a Backlink
Updates the backlink with the given the id. Returns the updated backlink
object upon success.
Arguments
id required integer (32) | The ID of the backlink to update. |
date_published date | The date the link was published. The date should be passed as a string in the format of |
status string | The status of the backlink, may be either |
url string | The url which contains the backlink |
link_type string | The type of link |
notes string | A small note that can be used to help describe the backlink. For example "Wrote article on NewsBuzz" |
title string | The title of the link |
target_anchor string | The text of the target anchor |
target_url string | The url of the target |
Endpoint
PUT /v3/backlinks/:id
Response
{ "metadata": { "total_pages": 1, "total_records": 1 }, "data": { "id": 1, "date_created": "2018-11-07", "date_published": "2018-11-07", "title": "test", "url": "http://www.test.com", "status": "published", "link_type": "Links Page", "target_anchor": "Click here", "target_url": "http://example.com/article", "notes": "Wrote article on NewsBuzz.", "domain_authority": 0, "page_authority": 0 } }
List all Backlinks
Returns an array containing all available backlinks belonging to the given campaign.
Arguments
campaign_id required integer (32) | The ID of the campaign to list backlinks for |
status string | The current status of link, may be either |
page integer (32) | The page of results to return |
limit integer (32) | Maximum number of records to return |
sort_metric string | The field of the |
sort_direction string | The direction of the sort specified by |
date_string string | A string representing the range of data to return, for example |
search string | Text to search for in backlinks. Only backlinks which full or partially match this parameter will be returned. |
link_type string | The type of backlink to return, such as |
Endpoint
GET /v3/resources/backlinks/manager/links
Response
{ "metadata": { "total_pages": 1, "total_records": 1 }, "data": [ { "id": 1, "date_created": "2018-11-07", "date_published": "2018-11-07", "title": "test", "url": "http://www.test.com", "status": "published", "link_type": "Links Page", "notes": "Wrote article on NewsBuzz.", "domain_authority": 0, "page_authority": 0 } ] }
Delete a Backlink
Deletes the backlink with the given id. This endpoint returns HTTP 204 No Content
when the backlink is successfully deleted.
Arguments
id required integer (32) | The ID of the backlink to delete. |
Endpoint
DELETE /v3/backlinks/:id