Skip to content
/
Get workflow reports

Semify Enterprise REST APIs (2.0.0)

This is the documentation for the Semify Endpoints based on the OpenAPI 3.0 specification. You can find out more about Swagger at http://swagger.io.

Find more info here
Download OpenAPI description
openapi.json
openapi.yaml
Overview
URL

https://www.semify.com

API Support

developers@semify.com

License

Apache 2.0

Languages
Servers
Mock server

https://developers.semify.com/_mock/openapi/

Sandbox

https://uat.services.semify.com/

Production Server

https://services.semify.com/

accounts

Operations related to accounts.

Operations

keywords

Operations related to keywords.

Operations

reports

Reporting endpoints.

Operations

Get keyword reports

Request

A secured route for getting keyword reports

Security
JWTAuth
Path
account_idintegerrequired

Account ID of the requested account

campaign_idintegerrequired

Campaign ID of the requested account

curl -i -X GET \
  'https://developers.semify.com/_mock/openapi/api/v1/reports/keywords/accounts/{account_id}/campaigns/{campaign_id}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful retrieval of keyword report data

Bodyapplication/json
dataArray of objects
Example: [{"rank_google_organic":5,"rank_google_map":1,"rank_id":12344,"search_total":50,"histogram":[{"date":"2024-04-10T04:04:00","rank_google_organic":13},{"date":"2024-04-16T04:04:00","rank_google_map":1}],"keyword":"home improvements maryland","type":"target"}]
messagesArray of strings
Example: []
paginationobject
Example: {"maxRows":0,"totalPages":1,"offset":0,"page":1,"totalRecords":0}
errorboolean
Example: false
Response
application/json
{
  "data": [
    { … }
  ],
  "messages": [],
  "pagination": {
    "maxRows": 0,
    "totalPages": 1,
    "offset": 0,
    "page": 1,
    "totalRecords": 0
  },
  "error": false
}

Get google analytics traffic reports

Request

A secured route for getting google analytics traffic reports

Security
JWTAuth
Path
account_idintegerrequired

Account ID of the requested account

campaign_idintegerrequired

Campaign ID of the requested account

date_fromstring

date from optional parameter

date_tostring

date to optional parameter

curl -i -X GET \
  'https://developers.semify.com/_mock/openapi/api/v1/reports/google/analytics/traffic/accounts/{account_id}/campaigns/{campaign_id}/date_from/{date_from}/date_to/{date_to}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful retrieval of google analytics traffic reports

Bodyapplication/json
dataArray of objects
Example: [{"date":"2023-11-01 00:00:00","organic":86,"non_organic":211,"total":297}]
messagesArray of strings
Example: []
paginationobject
Example: {"maxRows":0,"totalPages":1,"offset":0,"page":1,"totalRecords":0}
errorboolean
Example: false
Response
application/json
{
  "data": [
    { … }
  ],
  "messages": [],
  "pagination": {
    "maxRows": 0,
    "totalPages": 1,
    "offset": 0,
    "page": 1,
    "totalRecords": 0
  },
  "error": false
}

Get workflow reports

Request

A secured route for getting workflow reports

Security
JWTAuth
Path
account_idintegerrequired

Account ID of the requested account

campaign_idintegerrequired

Campaign ID of the requested account

date_fromstring

date from optional parameter

date_tostring

date to optional parameter

curl -i -X GET \
  'https://developers.semify.com/_mock/openapi/api/v1/reports/workflows/accounts/{account_id}/campaigns/{campaign_id}/date_from/{date_from}/date_to/{date_to}' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Successful retrieval of workflows reports

Bodyapplication/json
dataArray of objects
Example: [{"built_date":"2019-07-23 00:00:00","due_date":"2019-07-24 00:00:00","completion_date":"2019-07-23 00:00:00","task_id":11571961,"task_name":"Article - Published","status":"Completed"}]
messagesArray of strings
Example: []
paginationobject
Example: {"maxRows":0,"totalPages":1,"offset":0,"page":1,"totalRecords":0}
errorboolean
Example: false
Response
application/json
{
  "data": [
    { … }
  ],
  "messages": [],
  "pagination": {
    "maxRows": 0,
    "totalPages": 1,
    "offset": 0,
    "page": 1,
    "totalRecords": 0
  },
  "error": false
}

products

Product management endpoints.

Operations

authentication

Authentication/authorization endpoints.

Operations

campaigns

Campaigns and related operations.

Operations

google gbp accounts

Google GBP account endpoints.

Operations