marketo op get campaigns

Get Marketo Campaigns

Version: 17.07

Supported Since: 17.07

Get Marketo Campaigns connector operation provides the facilities to fetch Marketo Campaigns related information. This connector operation provides the following sub operations.

All these operations require Read-Only Campaigns or Read-Write Campaigns permissions from Marketo API.

Get Campaigns list

Get Campaigns list operation can be used to fetch a list of campaign records.

Parameters

* marked fields are mandatory

Filter type

Basic

The type to filter to be applied to the Campaigns list. By default no filters are applied.

  1. Filter By Campaign IDs - Filter the campaigns list by the Campaigns with the given IDs

  2. Filter By Campaign names - Filter the campaigns list by the Campaigns with the given names

  3. Filter By Program names - Filter the campaigns list by the Campaigns which are children of the designated programs

  4. Filter By Workspace names - Filter the campaigns list by the Campaigns in the given workspaces

Campaign IDs *

Basic

This parameter is only applicable if Filter type parameter is set to Filter By Campaign IDs.

A Comma-separated list of campaign IDs (as Integers) to filter the returned campaigns. This can be specified as a constant value or as a combination of placeholder expressions.

Campaign Names *

Basic

This parameter is only applicable if Filter type parameter is set to Filter By Campaign names.

A Comma-separated list of campaign names to filter the returned campaigns. This can be specified as a constant value or as a combination of placeholder expressions.

Program Names *

Basic

This parameter is only applicable if Filter type parameter is set to Filter By Program names.

A Comma-separated list of Program names to filter the returned campaigns. If set, only the campaigns which are children of the specified programs will be returned. This can be specified as a constant value or as a combination of placeholder expressions.

Workspace Names *

Basic

This parameter is only applicable if Filter type parameter is set to Filter By Workspace names.

A Comma-separated list of Workspace names to filter the returned campaigns. If set, only the campaigns in the given workspaces will be returned. This can be specified as a constant value or as a combination of placeholder expressions.

Batch Size

Basic

The size of the batch to return. The maximum and default value is 300.

Next Page Token

Basic

A token will be returned by this endpoint if the result set is greater than the batch size and that can be passed in a subsequent call through this parameter. This can be specified as a constant value or as a combination of placeholder expressions.

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "active": false,
      "createdAt": "string",
      "description": "string",
      "id": 0,
      "name": "string",
      "programId": 0,
      "programName": "string",
      "type": "batch",
      "updatedAt": "string",
      "workspaceName": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}

Get Campaign by ID

Get Campaign by ID operation can be used to retrieve a single campaign by ID.

Parameters

* marked fields are mandatory

Campaign ID *

Basic

The ID of the Campaign to retrieve. This should be an integer and can be specified as a constant value or as a combination of placeholder expressions.

Response

If this operation was invoked successfully, it will provide a response message with a JSON payload of the following format.

{
  "errors": [
    {
      "code": 0,
      "message": "string"
    }
  ],
  "moreResult": false,
  "nextPageToken": "string",
  "requestId": "string",
  "result": [
    {
      "active": false,
      "createdAt": "string",
      "description": "string",
      "id": 0,
      "name": "string",
      "programId": 0,
      "programName": "string",
      "type": "batch",
      "updatedAt": "string",
      "workspaceName": "string"
    }
  ],
  "success": false,
  "warnings": [
    {
      "code": 0,
      "message": "string"
    }
  ]
}
In this topic
In this topic
Contact Us