Optmyzr User Data API API Reference

Enables user to get associated data in JSON format. You will need an API Token to access this API. Contact your Optmyzr Account Manager for an API token.

API Endpoint

https://dataaccess.optmyzr.com

Contact: support@optmyzr.com

Schemes: https

Version: v1

Paths

OptmyzrAPI

API List

GET /UserData/V1/GetAPIList

Gets Set of supported API operation Names

token: string

in query

User Token

200 OK

type

string[]

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

[
  "string"
]

OptmyzrAPI

Optimization Suggestions

GET /UserData/V1/OptimizationSuggestions

Gets the optimization suggestions for the accounts associated with your API token.

token: string

in query

User Token

accountId: string

in query

The Id of the account for which the data should be returned. It is an optional parameter and if it is not specified or if the value is null or empty it will return data for all associated Optmyzr accounts of the user

accountType: string

in query

The type of the account (AdWords/ Bing Ads). It is an optional parameter and if it is not specified or if the value is null or empty it will return data for both AdWords and Bing Ads account types

toolName: string

in query

The tool name/optimization for which data is required. It is an optional parameter and if it is not specified or if the value is null or empty it will return data for all tools

emailId: string

in query

This lets you filter data associated with a specific child email address. It is an optional parameter and if it is not specified or if the value is null or empty it will return data associated with that of the user whose token is specified

200 OK

OptimizationSuggestionsResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "entries": [
    {
      "accountId": "string",
      "accountName": "string",
      "accountType": "string",
      "changes": "integer (int32)",
      "toolName": "string",
      "link": "string"
    }
  ]
}

OptmyzrAPI

Optimization History

GET /UserData/V1/OptimizationHistory

Gets the optimizations applied for the accounts associated with your API token

token: string

in query

User Token

accountId: string

in query

accountType: string

in query

The type of the account (AdWords/ Bing Ads). It is an optional parameter and if it is not specified or if the value is null or empty it will return data for both AdWords and Bing Ads account types

toolName: string

in query

The optimization for which data should be returned. It is an optional parameter and if it is not specified or if the value is null or empty it will return data for all optimizations applied

emailId: string

in query

startDate: string (date-time)

in query

Corresponds to the start date of the period for which the data should be returned. The format of the dates should be mm-dd-yy. For example: 02-17-2018, corresponds to Feb 17th of 2018. If this filter is not specified or if the value is null or empty it fetches the data for the past 30days.

endDate: string (date-time)

in query

Corresponds to the end date of the period for which the data should be returned. The format of the dates should be mm-dd-yy. For example: 02-17-2018, corresponds to Feb 17th of 2018. If this filter is not specified or if the value is null or empty it fetches the data for the past 30days.

200 OK

OptimizationHistoryResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "entries": [
    {
      "accountId": "string",
      "accountName": "string",
      "accountType": "string",
      "timestamp": "string (date-time)",
      "changes": "integer (int32)",
      "status": "string",
      "notes": "string",
      "fullName": "string",
      "emailId": "string",
      "toolName": "string"
    }
  ]
}

OptmyzrAPI

Active Alerts

GET /UserData/V1/ActiveAlerts

Gets the Active Alerts for the accounts associated with your API token

token: string

in query

User Token

accountId: string

in query

accountType: string

in query

The type of the account (AdWords/ Bing Ads). It is an optional parameter and if it is not specified or if the value is null or empty it will return data for both AdWords and Bing Ads account types

emailId: string

in query

200 OK

ActiveAlertsResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "entries": [
    {
      "accountName": "string",
      "accountId": "string",
      "accountType": "string",
      "alertType": "string",
      "alertDetails": "string",
      "link": "string"
    }
  ]
}

OptmyzrAPI

Metrics

GET /UserData/V1/Metrics

Gets the Metrics (Currently it only supports Quality score) for the accounts associated with your API token.

token: string

in query

User Token

accountId: string

in query

accountType: string

in query

The type of the account (AdWords/ Bing Ads). It is an optional parameter and if it is not specified or if the value is null or empty it will return data for both AdWords and Bing Ads account types

emailId: string

in query

200 OK

MetricsResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "entries": [
    {
      "accountName": "string",
      "accountId": "string",
      "accountType": "string",
      "timeStamp": "string",
      "qualityScore": "string"
    }
  ]
}

OptmyzrAPI

Accounts

GET /UserData/V1/Accounts

Gets the accounts and corresponding association status (account owner or starred accounts) for the accounts associated with your API token.

token: string

in query

User Token

emailId: string

in query

Returns JSON response with list of AccountDetail. It is an optional parameter and if it is not specified or if the value is null or empty it will return data for all associated Optmyzr accounts of the user

200 OK

AccountsResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "entries": [
    {
      "accountName": "string",
      "accountId": "string",
      "accountType": "string",
      "associationStatus": "string"
    }
  ]
}

OptmyzrAPI

Workout History

GET /UserData/V1/WorkoutHistory

Gets the Workout History for the accounts associated with your API token.

token: string

in query

User Token

accountId: string

in query

emailId: string

in query

This lets you filter data with accounts associated with specific child email address. It is an optional parameter and if it is not specified or if the value is null or empty it will return data for the accounts associated with that of the user whose token is specified

completedStatus: boolean

in query

This lets you filter data based on the workout completion status. It is an optional parameter and if it is not speicified it will return data for all the workouts

200 OK

WorkoutHistoryResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "entries": [
    {
      "completed": "boolean",
      "description": "string",
      "title": "string",
      "type": "string",
      "updatedByName": "string",
      "timestamp": "integer (int64)",
      "updatetime": "integer (int64)",
      "tasksCompleted": "integer (int32)",
      "accountId": "string",
      "accountType": "string",
      "accountName": "string"
    }
  ]
}

OptmyzrAPI

Workouts

GET /UserData/V1/Workouts

Gets the Custom workouts associated with your API token.

token: string

in query

User Token

200 OK

WorkoutsResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "entries": [
    {
      "title": "string",
      "description": "string",
      "updatedTime": "string (date-time)",
      "autoSkip": "boolean"
    }
  ]
}

OptmyzrAPI

Blueprint Tasks

GET /UserData/V1/BlueprintTasks

token: string

in query

User Token

page: integer (int32)

in query

Specify the page to retrieve. You will need to use this setting if you wish to retrieve specific pages. The page size is 1000. In order to retrieve the 5th page, you need to set page=5. If you send a request for a page that does not exist, or is out-of-range (i.e. when page > numberOfPages), we do not return an error. Instead, we return 0 results.

accountId: string

in query

The Id of the ads account for which the data should be returned. It is an optional parameter and if it is not specified or if the value is null or empty it will return data for all associated accounts of the user

emailId: string

in query

This lets you filter task data associated with a specific email address. It is an optional parameter and if it is not specified or if the value is null or empty it will return data associated with that of the user whose token is specified

status: string

in query

This lets you filter data based on the task status. It is an optional parameter and if it is not speicified it will return data for all the tasks

dueDateStart: string (date-time)

in query

Corresponds to the start date of the period for which the data should be returned. It is an optional parameter. The format of the dates should be mm-dd-yy. For example: 02-17-2018, corresponds to Feb 17th of 2018. If this filter is not specified or if the value is null or empty it fetches the data for the all time.

dueDateEnd: string (date-time)

in query

Corresponds to the end date of the period for which the data should be returned. It is an optional parameter. The format of the dates should be mm-dd-yy. For example: 02-17-2018, corresponds to Feb 17th of 2018. If this filter is not specified or if the value is null or empty it fetches the data for the all time.

200 OK

BlueprintTasksResponse

Response Content-Types: application/json, text/json, application/xml, text/xml

Response Example (200 OK)

{
  "entries": [
    {
      "title": "string",
      "description": "string",
      "accountId": "string",
      "accountName": "string",
      "assigneeEmail": "string",
      "link": "string",
      "status": "string",
      "completedByEmail": "string",
      "completedDate": "string (date-time)",
      "dueDate": "string (date-time)"
    }
  ]
}

Schema Definitions

OptimizationSuggestionsResponse: object

Contains the Collection of OptimizationSuggestion

entries: OptimizationSuggestion: Collection of OptimizationSuggestion collection
OptimizationSuggestion

Example

{
  "entries": [
    {
      "accountId": "string",
      "accountName": "string",
      "accountType": "string",
      "changes": "integer (int32)",
      "toolName": "string",
      "link": "string"
    }
  ]
}

OptimizationSuggestion: object

Gives details about OptimizationSuggestion

accountId: string: It specifies the id of the AdWords/Bing account the record corresponds to
accountName: string: It specifies the name of the AdWords/Bing account the record corresponds to
accountType: string: The type of the account (AdWords or Bing Ads)
changes: integer (int32): The number of changes suggested
toolName: string: The name of the optimization tool
link: string: Link to the optimization tool that will take the user to the Optmyzr interface

Example

{
  "accountId": "string",
  "accountName": "string",
  "accountType": "string",
  "changes": "integer (int32)",
  "toolName": "string",
  "link": "string"
}

OptimizationHistoryResponse: object

Contains the collection of Optimization details applied

entries: OptimizationHistory: Collection of Optimization detail applied
OptimizationHistory

Example

{
  "entries": [
    {
      "accountId": "string",
      "accountName": "string",
      "accountType": "string",
      "timestamp": "string (date-time)",
      "changes": "integer (int32)",
      "status": "string",
      "notes": "string",
      "fullName": "string",
      "emailId": "string",
      "toolName": "string"
    }
  ]
}

OptimizationHistory: object

Gives the details of the optimization applied

accountId: string: It specifies the id of the AdWords/Bing account the record corresponds to
accountName: string: It specifies the Name of the AdWords/Bing account the record corresponds to
accountType: string: The type of the account (AdWords/ Bing Ads)
timestamp: string (date-time): The time when which the optimization is applied
changes: integer (int32): The number of times the optimization was applied
status: string: The status of the application whether it was completed or not
notes: string: Any notes associated with the record
fullName: string: Full Name of the user
emailId: string: Emailid of the user
toolName: string: The name of the optimzation tool

Example

{
  "accountId": "string",
  "accountName": "string",
  "accountType": "string",
  "timestamp": "string (date-time)",
  "changes": "integer (int32)",
  "status": "string",
  "notes": "string",
  "fullName": "string",
  "emailId": "string",
  "toolName": "string"
}

ActiveAlertsResponse: object

Contains the collection of alert details

entries: ActiveAlert: Collection of alert details
ActiveAlert

Example

{
  "entries": [
    {
      "accountName": "string",
      "accountId": "string",
      "accountType": "string",
      "alertType": "string",
      "alertDetails": "string",
      "link": "string"
    }
  ]
}

ActiveAlert: object

Gives the details of the alert

accountName: string: It specifies the name of the AdWords/Bing account the record corresponds to
accountId: string: It specifies the id of the AdWords/Bing account the record corresponds to
accountType: string: The type of the account (AdWords/ Bing Ads)
alertType: string: It tells the type of the alert (Alert/Auto Alert)
alertDetails: string: It gives details of the alert and includes both auto and custom alerts
link: string: It corresponds to the link to the alert the record corresponds to.

Example

{
  "accountName": "string",
  "accountId": "string",
  "accountType": "string",
  "alertType": "string",
  "alertDetails": "string",
  "link": "string"
}

MetricsResponse: object

Contains the collection of metric details

entries: Metrics: Collection of metric details
Metrics

Example

{
  "entries": [
    {
      "accountName": "string",
      "accountId": "string",
      "accountType": "string",
      "timeStamp": "string",
      "qualityScore": "string"
    }
  ]
}

Metrics: object

Gives the details of the Metric (quality score)

accountName: string: It specifies the name of the AdWords/Bing account the record corresponds to
accountId: string: It specifies the id of the AdWords/Bing account the record corresponds to
accountType: string: The type of the account (AdWords/ Bing Ads)
timeStamp: string: The time stamp at which the corresponding metric was collected and evaluated.
qualityScore: string: The corresponding Quality Score of the account.

Example

{
  "accountName": "string",
  "accountId": "string",
  "accountType": "string",
  "timeStamp": "string",
  "qualityScore": "string"
}

AccountsResponse: object

Contains the collection of account and its association details

entries: Account: Collection of account details
Account

Example

{
  "entries": [
    {
      "accountName": "string",
      "accountId": "string",
      "accountType": "string",
      "associationStatus": "string"
    }
  ]
}

Account: object

Gives the details of the account and its association with the user

accountName: string: It specifies the name of the AdWords/Bing account the record corresponds to
accountId: string: It specifies the id of the AdWords/Bing account the record corresponds to
accountType: string: The type of the account (AdWords/ Bing Ads)
associationStatus: string: The association status of the account to the user (account owner or starred account) or none of the above (represented as "-").

Example

{
  "accountName": "string",
  "accountId": "string",
  "accountType": "string",
  "associationStatus": "string"
}

WorkoutHistoryResponse: object

Contains the collection of Workout details created

entries: WorkoutHistory: Collection of Workout detail created
WorkoutHistory

Example

{
  "entries": [
    {
      "completed": "boolean",
      "description": "string",
      "title": "string",
      "type": "string",
      "updatedByName": "string",
      "timestamp": "integer (int64)",
      "updatetime": "integer (int64)",
      "tasksCompleted": "integer (int32)",
      "accountId": "string",
      "accountType": "string",
      "accountName": "string"
    }
  ]
}

WorkoutHistory: object

Gives the details of the WorkoutHistory

completed: boolean: It specifies the status of the workout
description: string: It specifies the description of the workout
title: string: It specifies the title of the workout
type: string: It specifies the type of the workout whether custom or prebuilt
updatedByName: string: It specifies the name of the user who updated the workout
timestamp: integer (int64): It specifies the timestamp when the workout was created
updatetime: integer (int64): It specifies the updated time of the workout
tasksCompleted: integer (int32): It specifies the number of tasks completed in the workout
accountId: string: It specifies the account Id of the workout
accountType: string: It specifies the account type of the workout
accountName: string: It specifies the account name of the workout

Example

{
  "completed": "boolean",
  "description": "string",
  "title": "string",
  "type": "string",
  "updatedByName": "string",
  "timestamp": "integer (int64)",
  "updatetime": "integer (int64)",
  "tasksCompleted": "integer (int32)",
  "accountId": "string",
  "accountType": "string",
  "accountName": "string"
}

WorkoutsResponse: object

Contains the collection of workouts created

entries: Workout: Collection of workouts created
Workout

Example

{
  "entries": [
    {
      "title": "string",
      "description": "string",
      "updatedTime": "string (date-time)",
      "autoSkip": "boolean"
    }
  ]
}

Workout: object

Gives the details of the Workouts created

title: string: It specifies the title of the workout
description: string: Description of the workout
updatedTime: string (date-time): The time when the workout was updated
autoSkip: boolean: specifies wheter the auto skip is enabled or not for the workout

Example

{
  "title": "string",
  "description": "string",
  "updatedTime": "string (date-time)",
  "autoSkip": "boolean"
}

BlueprintTasksResponse: object

Contains the collection of Blueprint task

entries: BlueprintTask: Collection of blueprint tasks
BlueprintTask

Example

{
  "entries": [
    {
      "title": "string",
      "description": "string",
      "accountId": "string",
      "accountName": "string",
      "assigneeEmail": "string",
      "link": "string",
      "status": "string",
      "completedByEmail": "string",
      "completedDate": "string (date-time)",
      "dueDate": "string (date-time)"
    }
  ]
}

BlueprintTask: object

title: string: It specifies the title of the Task
description: string: Description about task
accountId: string: Account Id for which task is created
accountName: string: Name of account for which task is created
assigneeEmail: string: Email of the assignee of the task
link: string: Url to load task in optmyzr
status: string: status of the task
completedByEmail: string: Email of the user who completed the task
completedDate: string (date-time): Date when task is completed
dueDate: string (date-time): Due date of the task

Example

{
  "title": "string",
  "description": "string",
  "accountId": "string",
  "accountName": "string",
  "assigneeEmail": "string",
  "link": "string",
  "status": "string",
  "completedByEmail": "string",
  "completedDate": "string (date-time)",
  "dueDate": "string (date-time)"
}

Documentation by Spectacle