customerio-campaigns

Server path: /customerio-campaigns | Type: Application | PCID required: Yes

Tools

Tool	Description
`customerio_campaigns_broadcast_action_links`	Get broadcast action link metrics
`customerio_campaigns_broadcast_action_metrics`	Get broadcast action metrics
`customerio_campaigns_broadcast_actions`	List broadcast actions
`customerio_campaigns_broadcast_errors`	Get broadcast error descriptions
`customerio_campaigns_broadcast_links`	Get broadcast link metrics
`customerio_campaigns_broadcast_messages`	Get messages for a broadcast
`customerio_campaigns_broadcast_metrics`	Get broadcast metrics
`customerio_campaigns_broadcast_status`	Get the status of a broadcast
`customerio_campaigns_campaign_action_links`	Get link metrics for an action
`customerio_campaigns_campaign_action_metrics`	Get campaign action metrics
`customerio_campaigns_campaign_journey_metrics`	Get campaign journey metrics
`customerio_campaigns_campaign_link_metrics`	Get campaign link metrics
`customerio_campaigns_campaign_metrics`	Get campaign metrics
`customerio_campaigns_get_broadcast`	Get a broadcast
`customerio_campaigns_get_broadcast_action`	Get a broadcast action
`customerio_campaigns_get_broadcast_action_language`	Get a translation of a broadcast message
`customerio_campaigns_get_campaign_action`	Get a campaign action
`customerio_campaigns_get_campaign_action_translation`	Get a translation of a campaign message
`customerio_campaigns_get_campaign_messages`	Get campaign message metadata
`customerio_campaigns_get_campaigns`	Get a campaign
`customerio_campaigns_list_broadcast_triggers`	Get broadcast triggers
`customerio_campaigns_list_broadcasts`	List broadcasts
`customerio_campaigns_list_campaign_actions`	List campaign actions
`customerio_campaigns_list_campaigns`	List campaigns
`customerio_campaigns_update_broadcast_action`	Update a broadcast action
`customerio_campaigns_update_broadcast_action_language`	Update a translation of a broadcast message
`customerio_campaigns_update_campaign_action`	Update a campaign action
`customerio_campaigns_update_campaign_action_translation`	Update a translation of a campaign message

customerio_campaigns_broadcast_action_links

Get broadcast action link metrics Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.
`action_id`	integer	Yes	—	The action you want to lookup or act on.
`period`	string	No	—	The unit of time for your report.
`steps`	integer	No	—	The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month.
`type`	string	No	—	The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    },
    "period": {
      "type": "string",
      "description": "The unit of time for your report.",
      "enum": [
        "hours",
        "days",
        "weeks",
        "months"
      ]
    },
    "steps": {
      "type": "integer",
      "description": "The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month."
    },
    "type": {
      "type": "string",
      "description": "The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.",
      "enum": [
        "email",
        "webhook",
        "twilio",
        "whatsapp",
        "slack",
        "push",
        "in_app"
      ]
    }
  },
  "required": [
    "PCID",
    "broadcast_id",
    "action_id"
  ]
}

customerio_campaigns_broadcast_action_metrics

Get broadcast action metrics Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.
`action_id`	integer	Yes	—	The action you want to lookup or act on.
`period`	string	No	—	The unit of time for your report.
`steps`	integer	No	—	The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month.
`type`	string	No	—	The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    },
    "period": {
      "type": "string",
      "description": "The unit of time for your report.",
      "enum": [
        "hours",
        "days",
        "weeks",
        "months"
      ]
    },
    "steps": {
      "type": "integer",
      "description": "The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month."
    },
    "type": {
      "type": "string",
      "description": "The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.",
      "enum": [
        "email",
        "webhook",
        "twilio",
        "whatsapp",
        "slack",
        "push",
        "in_app"
      ]
    }
  },
  "required": [
    "PCID",
    "broadcast_id",
    "action_id"
  ]
}

customerio_campaigns_broadcast_actions

List broadcast actions Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    }
  },
  "required": [
    "PCID",
    "broadcast_id"
  ]
}

customerio_campaigns_broadcast_errors

Get broadcast error descriptions Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The ID of the broadcast that you want to return information about.
`trigger_id`	integer	Yes	—	The ID of the campaign trigger that you want to return information for.
`start`	string	No	—	The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to return the next page of results.
`limit`	integer	No	—	The maximum number of results you want to retrieve per page.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The ID of the broadcast that you want to return information about."
    },
    "trigger_id": {
      "type": "integer",
      "description": "The ID of the campaign trigger that you want to return information for."
    },
    "start": {
      "type": "string",
      "description": "The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to return the next page of results."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of results you want to retrieve per page."
    }
  },
  "required": [
    "PCID",
    "broadcast_id",
    "trigger_id"
  ]
}

customerio_campaigns_broadcast_links

Get broadcast link metrics Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.
`period`	string	No	—	The unit of time for your report.
`steps`	integer	No	—	The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month.
`unique`	boolean	No	—	If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the response contains the total number of results without regard to uniqueness.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    },
    "period": {
      "type": "string",
      "description": "The unit of time for your report.",
      "enum": [
        "hours",
        "days",
        "weeks",
        "months"
      ]
    },
    "steps": {
      "type": "integer",
      "description": "The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month."
    },
    "unique": {
      "type": "boolean",
      "description": "If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the response contains the total number of results without regard to uniqueness."
    }
  },
  "required": [
    "PCID",
    "broadcast_id"
  ]
}

customerio_campaigns_broadcast_messages

Get messages for a broadcast Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.
`start`	string	No	—	The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to return the next page of results.
`limit`	integer	No	—	The maximum number of results you want to retrieve per page.
`metric`	string	No	—	Determines the metric(s) you want to return.
`state`	string	No	—	The state of a broadcast.
`type`	string	No	—	The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.
`start_ts`	integer	No	—	The beginning timestamp for your query.
`end_ts`	integer	No	—	The ending timestamp for your query.
`get_tracked_responses`	boolean	No	—	If true, the response includes `tracked_responses` for each message—an object containing tracked response option names for in-app survey responses.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    },
    "start": {
      "type": "string",
      "description": "The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to return the next page of results."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of results you want to retrieve per page."
    },
    "metric": {
      "type": "string",
      "description": "Determines the metric(s) you want to return.",
      "enum": [
        "attempted",
        "sent",
        "delivered",
        "opened",
        "clicked",
        "converted",
        "bounced",
        "spammed",
        "unsubscribed",
        "dropped",
        "failed",
        "undeliverable"
      ]
    },
    "state": {
      "type": "string",
      "description": "The state of a broadcast.",
      "enum": [
        "failed",
        "sent",
        "drafted",
        "attempted"
      ]
    },
    "type": {
      "type": "string",
      "description": "The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.",
      "enum": [
        "email",
        "webhook",
        "twilio",
        "whatsapp",
        "slack",
        "push",
        "in_app"
      ]
    },
    "start_ts": {
      "type": "integer",
      "description": "The beginning timestamp for your query."
    },
    "end_ts": {
      "type": "integer",
      "description": "The ending timestamp for your query."
    },
    "get_tracked_responses": {
      "type": "boolean",
      "description": "If true, the response includes `tracked_responses` for each message—an object containing tracked response option names for in-app survey responses."
    }
  },
  "required": [
    "PCID",
    "broadcast_id"
  ]
}

customerio_campaigns_broadcast_metrics

Get broadcast metrics Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.
`period`	string	No	—	The unit of time for your report.
`steps`	integer	No	—	The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month.
`type`	string	No	—	The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    },
    "period": {
      "type": "string",
      "description": "The unit of time for your report.",
      "enum": [
        "hours",
        "days",
        "weeks",
        "months"
      ]
    },
    "steps": {
      "type": "integer",
      "description": "The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month."
    },
    "type": {
      "type": "string",
      "description": "The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.",
      "enum": [
        "email",
        "webhook",
        "twilio",
        "whatsapp",
        "slack",
        "push",
        "in_app"
      ]
    }
  },
  "required": [
    "PCID",
    "broadcast_id"
  ]
}

customerio_campaigns_broadcast_status

Get the status of a broadcast Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The ID of the broadcast that you want to return information about.
`trigger_id`	integer	Yes	—	The ID of the campaign trigger that you want to return information for.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The ID of the broadcast that you want to return information about."
    },
    "trigger_id": {
      "type": "integer",
      "description": "The ID of the campaign trigger that you want to return information for."
    }
  },
  "required": [
    "PCID",
    "broadcast_id",
    "trigger_id"
  ]
}

customerio_campaigns_campaign_action_links

Get link metrics for an action Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.
`action_id`	integer	Yes	—	The action you want to lookup or act on.
`period`	string	No	—	The unit of time for your report.
`steps`	integer	No	—	The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month.
`type`	string	No	—	The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    },
    "period": {
      "type": "string",
      "description": "The unit of time for your report.",
      "enum": [
        "hours",
        "days",
        "weeks",
        "months"
      ]
    },
    "steps": {
      "type": "integer",
      "description": "The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month."
    },
    "type": {
      "type": "string",
      "description": "The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.",
      "enum": [
        "email",
        "webhook",
        "twilio",
        "whatsapp",
        "slack",
        "push",
        "in_app"
      ]
    }
  },
  "required": [
    "PCID",
    "campaign_id",
    "action_id"
  ]
}

customerio_campaigns_campaign_action_metrics

Get campaign action metrics Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.
`action_id`	integer	Yes	—	The action you want to lookup or act on.
`version`	string	Yes	—	The version of the metrics API to use.
`type`	string	No	—	The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.
`res`	string	No	—	Version 2 only. Determines increment for metrics—hourly, daily, weekly, or monthly.
`tz`	string	No	—	Version 2 only. The time zone for the metrics you are requesting. If you do not provide a time zone, we use EST. You must use the region format.
`start`	integer	No	—	Version 2 only. The unix timestamp for the beginning of your metrics.
`end`	integer	No	—	Version 2 only. The unix timestamp for the end of your metrics. Limited to 10 years from the `start` parameter.
`period`	string	No	—	Version 1 only. The unit of time for your report.
`steps`	integer	No	—	Version 1 only. The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 120 months.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    },
    "version": {
      "type": "string",
      "description": "The version of the metrics API to use.",
      "enum": [
        "1",
        "2"
      ]
    },
    "type": {
      "type": "string",
      "description": "The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.",
      "enum": [
        "email",
        "webhook",
        "twilio",
        "whatsapp",
        "slack",
        "push",
        "in_app"
      ]
    },
    "res": {
      "type": "string",
      "description": "**Version 2 only.** Determines increment for metrics—hourly, daily, weekly, or monthly.",
      "enum": [
        "hours",
        "hourly",
        "days",
        "daily",
        "weeks",
        "weekly",
        "months",
        "monthly"
      ]
    },
    "tz": {
      "type": "string",
      "description": "**Version 2 only.** The time zone for the metrics you are requesting. If you do not provide a time zone, we use EST. You must use the [region format](/journeys/send/timezones/example-timezones/#region-format)."
    },
    "start": {
      "type": "integer",
      "description": "**Version 2 only.** The unix timestamp for the beginning of your metrics."
    },
    "end": {
      "type": "integer",
      "description": "**Version 2 only.** The unix timestamp for the end of your metrics. Limited to 10 years from the `start` parameter."
    },
    "period": {
      "type": "string",
      "description": "**Version 1 only.** The unit of time for your report.",
      "enum": [
        "hours",
        "days",
        "weeks",
        "months"
      ]
    },
    "steps": {
      "type": "integer",
      "description": "**Version 1 only.** The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 120 months."
    }
  },
  "required": [
    "PCID",
    "campaign_id",
    "action_id",
    "version"
  ]
}

customerio_campaigns_campaign_journey_metrics

Get campaign journey metrics Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.
`start`	integer	Yes	—	The unix timestamp for the beginning of your journey metrics report.
`end`	integer	Yes	—	The unix timestamp for the end of your journey metrics report.
`res`	string	Yes	—	Determines increment for metrics—hourly, daily, weekly, or monthly.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    },
    "start": {
      "type": "integer",
      "description": "The unix timestamp for the beginning of your journey metrics report."
    },
    "end": {
      "type": "integer",
      "description": "The unix timestamp for the end of your journey metrics report."
    },
    "res": {
      "type": "string",
      "description": "Determines increment for metrics—hourly, daily, weekly, or monthly.",
      "enum": [
        "hours",
        "hourly",
        "days",
        "daily",
        "weeks",
        "weekly",
        "months",
        "monthly"
      ]
    }
  },
  "required": [
    "PCID",
    "campaign_id",
    "start",
    "end",
    "res"
  ]
}

customerio_campaigns_campaign_link_metrics

Get campaign link metrics Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.
`period`	string	No	—	The unit of time for your report.
`steps`	integer	No	—	The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month.
`unique`	boolean	No	—	If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the response contains the total number of results without regard to uniqueness.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    },
    "period": {
      "type": "string",
      "description": "The unit of time for your report.",
      "enum": [
        "hours",
        "days",
        "weeks",
        "months"
      ]
    },
    "steps": {
      "type": "integer",
      "description": "The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 121 months. Days start at 00:00 EST. Weeks start at 00:00 EST on Sunday. Months start at 00:00 EST on the 1st of the month."
    },
    "unique": {
      "type": "boolean",
      "description": "If true, the response contains only unique customer results, i.e. a customer who clicks a link twice is only counted once. If false, the response contains the total number of results without regard to uniqueness."
    }
  },
  "required": [
    "PCID",
    "campaign_id"
  ]
}

customerio_campaigns_campaign_metrics

Get campaign metrics Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.
`version`	string	Yes	—	The version of the metrics API to use.
`type`	string	No	—	The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.
`res`	string	No	—	Version 2 only. Determines increment for metrics—hourly, daily, weekly, or monthly.
`tz`	string	No	—	Version 2 only. The time zone for the metrics you are requesting. If you do not provide a time zone, we use EST. You must use the region format.
`start`	integer	No	—	Version 2 only. The unix timestamp for the beginning of your metrics.
`end`	integer	No	—	Version 2 only. The unix timestamp for the end of your metrics. Limited to 10 years from the `start` parameter.
`period`	string	No	—	Version 1 only. The unit of time for your report.
`steps`	integer	No	—	Version 1 only. The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 120 months.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    },
    "version": {
      "type": "string",
      "description": "The version of the metrics API to use.",
      "enum": [
        "1",
        "2"
      ]
    },
    "type": {
      "type": "string",
      "description": "The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.",
      "enum": [
        "email",
        "webhook",
        "twilio",
        "whatsapp",
        "slack",
        "push",
        "in_app"
      ]
    },
    "res": {
      "type": "string",
      "description": "**Version 2 only.** Determines increment for metrics—hourly, daily, weekly, or monthly.",
      "enum": [
        "hours",
        "hourly",
        "days",
        "daily",
        "weeks",
        "weekly",
        "months",
        "monthly"
      ]
    },
    "tz": {
      "type": "string",
      "description": "**Version 2 only.** The time zone for the metrics you are requesting. If you do not provide a time zone, we use EST. You must use the [region format](/journeys/send/timezones/example-timezones/#region-format)."
    },
    "start": {
      "type": "integer",
      "description": "**Version 2 only.** The unix timestamp for the beginning of your metrics."
    },
    "end": {
      "type": "integer",
      "description": "**Version 2 only.** The unix timestamp for the end of your metrics. Limited to 10 years from the `start` parameter."
    },
    "period": {
      "type": "string",
      "description": "**Version 1 only.** The unit of time for your report.",
      "enum": [
        "hours",
        "days",
        "weeks",
        "months"
      ]
    },
    "steps": {
      "type": "integer",
      "description": "**Version 1 only.** The number of periods you want to return. Defaults to the maximum available, or `12` if the period is in `months`. Maximums are 24 hours, 45 days, 12 weeks, or 120 months."
    }
  },
  "required": [
    "PCID",
    "campaign_id",
    "version"
  ]
}

customerio_campaigns_get_broadcast

Get a broadcast Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    }
  },
  "required": [
    "PCID",
    "broadcast_id"
  ]
}

customerio_campaigns_get_broadcast_action

Get a broadcast action Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.
`action_id`	integer	Yes	—	The action you want to lookup or act on.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    }
  },
  "required": [
    "PCID",
    "broadcast_id",
    "action_id"
  ]
}

customerio_campaigns_get_broadcast_action_language

Get a translation of a broadcast message Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.
`action_id`	integer	Yes	—	The action you want to lookup or act on.
`language`	string	Yes	—	A language tag of a language variant. If you don’t provide a language (an empty string), we’ll use your default language. If the language variant does not exist, we’ll return an error.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    },
    "language": {
      "type": "string",
      "description": "A [language tag](/journeys/channels/subscriptions/unsubscribe-faqs/#currently-supported-languages) of a language variant. If you don't provide a language (an empty string), we'll use your default language. If the language variant does not exist, we'll return an error."
    }
  },
  "required": [
    "PCID",
    "broadcast_id",
    "action_id",
    "language"
  ]
}

customerio_campaigns_get_campaign_action

Get a campaign action Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.
`action_id`	integer	Yes	—	The action you want to lookup or act on.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    }
  },
  "required": [
    "PCID",
    "campaign_id",
    "action_id"
  ]
}

customerio_campaigns_get_campaign_action_translation

Get a translation of a campaign message Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.
`action_id`	integer	Yes	—	The action you want to lookup or act on.
`language`	string	Yes	—	A language tag of a language variant. If you don’t provide a language (an empty string), we’ll use your default language. If the language variant does not exist, we’ll return an error.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    },
    "language": {
      "type": "string",
      "description": "A [language tag](/journeys/channels/subscriptions/unsubscribe-faqs/#currently-supported-languages) of a language variant. If you don't provide a language (an empty string), we'll use your default language. If the language variant does not exist, we'll return an error."
    }
  },
  "required": [
    "PCID",
    "campaign_id",
    "action_id",
    "language"
  ]
}

customerio_campaigns_get_campaign_messages

Get campaign message metadata Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.
`start`	string	No	—	The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to return the next page of results.
`limit`	integer	No	—	The maximum number of results you want to retrieve per page.
`type`	string	No	—	The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.
`metric`	string	No	—	Determines the metric(s) you want to return.
`drafts`	boolean	No	—	If true, your request returns drafts rather than active/sent messages.
`start_ts`	integer	No	—	The beginning timestamp for your query.
`end_ts`	integer	No	—	The ending timestamp for your query.
`get_tracked_responses`	boolean	No	—	If true, the response includes `tracked_responses` for each message—an object containing tracked response option names for in-app survey responses.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    },
    "start": {
      "type": "string",
      "description": "The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to return the next page of results."
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of results you want to retrieve per page."
    },
    "type": {
      "type": "string",
      "description": "The type of item you want to return metrics for. When empty, the response contains metrics for all possible types.",
      "enum": [
        "email",
        "webhook",
        "twilio",
        "whatsapp",
        "slack",
        "push",
        "in_app"
      ]
    },
    "metric": {
      "type": "string",
      "description": "Determines the metric(s) you want to return.",
      "enum": [
        "attempted",
        "sent",
        "delivered",
        "opened",
        "clicked",
        "converted",
        "bounced",
        "spammed",
        "unsubscribed",
        "dropped",
        "failed",
        "undeliverable"
      ]
    },
    "drafts": {
      "type": "boolean",
      "description": "If true, your request returns drafts rather than active/sent messages."
    },
    "start_ts": {
      "type": "integer",
      "description": "The beginning timestamp for your query."
    },
    "end_ts": {
      "type": "integer",
      "description": "The ending timestamp for your query."
    },
    "get_tracked_responses": {
      "type": "boolean",
      "description": "If true, the response includes `tracked_responses` for each message—an object containing tracked response option names for in-app survey responses."
    }
  },
  "required": [
    "PCID",
    "campaign_id"
  ]
}

customerio_campaigns_get_campaigns

Get a campaign Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    }
  },
  "required": [
    "PCID",
    "campaign_id"
  ]
}

customerio_campaigns_list_broadcast_triggers

Get broadcast triggers Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    }
  },
  "required": [
    "PCID",
    "broadcast_id"
  ]
}

customerio_campaigns_list_broadcasts

List broadcasts

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

customerio_campaigns_list_campaign_actions

List campaign actions Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.
`start`	string	No	—	The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to return the next page of results.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    },
    "start": {
      "type": "string",
      "description": "The token for the page of results you want to return. Responses contain a `next` property. Use this property as the `start` value to return the next page of results."
    }
  },
  "required": [
    "PCID",
    "campaign_id"
  ]
}

customerio_campaigns_list_campaigns

List campaigns

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    }
  },
  "required": [
    "PCID"
  ]
}

customerio_campaigns_update_broadcast_action

Update a broadcast action Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.
`action_id`	integer	Yes	—	The action you want to lookup or act on.
`body`	object	No	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    },
    "body": {
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "broadcast_id",
    "action_id"
  ]
}

customerio_campaigns_update_broadcast_action_language

Update a translation of a broadcast message Parameters:

Parameter	Type	Required	Default	Description
`broadcast_id`	integer	Yes	—	The identifier of a broadcast.
`action_id`	integer	Yes	—	The action you want to lookup or act on.
`language`	string	Yes	—	A language tag of a language variant. If you don’t provide a language (an empty string), we’ll use your default language. If the language variant does not exist, we’ll return an error.
`body`	object	No	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "broadcast_id": {
      "type": "integer",
      "description": "The identifier of a broadcast."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    },
    "language": {
      "type": "string",
      "description": "A [language tag](/journeys/channels/subscriptions/unsubscribe-faqs/#currently-supported-languages) of a language variant. If you don't provide a language (an empty string), we'll use your default language. If the language variant does not exist, we'll return an error."
    },
    "body": {
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "broadcast_id",
    "action_id",
    "language"
  ]
}

customerio_campaigns_update_campaign_action

Update a campaign action Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.
`action_id`	integer	Yes	—	The action you want to lookup or act on.
`body`	object	No	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    },
    "body": {
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "campaign_id",
    "action_id"
  ]
}

customerio_campaigns_update_campaign_action_translation

Update a translation of a campaign message Parameters:

Parameter	Type	Required	Default	Description
`campaign_id`	integer	Yes	—	The ID of the campaign that you want to trigger or return information about.
`action_id`	integer	Yes	—	The action you want to lookup or act on.
`language`	string	Yes	—	A language tag of a language variant. If you don’t provide a language (an empty string), we’ll use your default language. If the language variant does not exist, we’ll return an error.
`body`	object	No	—	Request body

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "campaign_id": {
      "type": "integer",
      "description": "The ID of the campaign that you want to trigger or return information about."
    },
    "action_id": {
      "type": "integer",
      "description": "The action you want to lookup or act on."
    },
    "language": {
      "type": "string",
      "description": "A [language tag](/journeys/channels/subscriptions/unsubscribe-faqs/#currently-supported-languages) of a language variant. If you don't provide a language (an empty string), we'll use your default language. If the language variant does not exist, we'll return an error."
    },
    "body": {
      "description": "Request body"
    }
  },
  "required": [
    "PCID",
    "campaign_id",
    "action_id",
    "language"
  ]
}

Platform API

Embedded MCP Servers

Application MCP Servers

Triggers API

Tools

customerio_campaigns_broadcast_action_links

customerio_campaigns_broadcast_action_metrics

customerio_campaigns_broadcast_actions

customerio_campaigns_broadcast_errors

customerio_campaigns_broadcast_links

customerio_campaigns_broadcast_messages

customerio_campaigns_broadcast_metrics

customerio_campaigns_broadcast_status

customerio_campaigns_campaign_action_links

customerio_campaigns_campaign_action_metrics

customerio_campaigns_campaign_journey_metrics

customerio_campaigns_campaign_link_metrics

customerio_campaigns_campaign_metrics

customerio_campaigns_get_broadcast

customerio_campaigns_get_broadcast_action

customerio_campaigns_get_broadcast_action_language

customerio_campaigns_get_campaign_action

customerio_campaigns_get_campaign_action_translation

customerio_campaigns_get_campaign_messages

customerio_campaigns_get_campaigns

customerio_campaigns_list_broadcast_triggers

customerio_campaigns_list_broadcasts

customerio_campaigns_list_campaign_actions

customerio_campaigns_list_campaigns

customerio_campaigns_update_broadcast_action

customerio_campaigns_update_broadcast_action_language

customerio_campaigns_update_campaign_action

customerio_campaigns_update_campaign_action_translation

​Tools

​customerio_campaigns_broadcast_action_links

​customerio_campaigns_broadcast_action_metrics

​customerio_campaigns_broadcast_actions

​customerio_campaigns_broadcast_errors

​customerio_campaigns_broadcast_links

​customerio_campaigns_broadcast_messages

​customerio_campaigns_broadcast_metrics

​customerio_campaigns_broadcast_status

​customerio_campaigns_campaign_action_links

​customerio_campaigns_campaign_action_metrics

​customerio_campaigns_campaign_journey_metrics

​customerio_campaigns_campaign_link_metrics

​customerio_campaigns_campaign_metrics

​customerio_campaigns_get_broadcast

​customerio_campaigns_get_broadcast_action

​customerio_campaigns_get_broadcast_action_language

​customerio_campaigns_get_campaign_action

​customerio_campaigns_get_campaign_action_translation

​customerio_campaigns_get_campaign_messages

​customerio_campaigns_get_campaigns

​customerio_campaigns_list_broadcast_triggers

​customerio_campaigns_list_broadcasts

​customerio_campaigns_list_campaign_actions

​customerio_campaigns_list_campaigns

​customerio_campaigns_update_broadcast_action

​customerio_campaigns_update_broadcast_action_language

​customerio_campaigns_update_campaign_action

​customerio_campaigns_update_campaign_action_translation

Tools

customerio_campaigns_broadcast_action_links

customerio_campaigns_broadcast_action_metrics

customerio_campaigns_broadcast_actions

customerio_campaigns_broadcast_errors

customerio_campaigns_broadcast_links

customerio_campaigns_broadcast_messages

customerio_campaigns_broadcast_metrics

customerio_campaigns_broadcast_status

customerio_campaigns_campaign_action_links

customerio_campaigns_campaign_action_metrics

customerio_campaigns_campaign_journey_metrics

customerio_campaigns_campaign_link_metrics

customerio_campaigns_campaign_metrics

customerio_campaigns_get_broadcast

customerio_campaigns_get_broadcast_action

customerio_campaigns_get_broadcast_action_language

customerio_campaigns_get_campaign_action

customerio_campaigns_get_campaign_action_translation

customerio_campaigns_get_campaign_messages

customerio_campaigns_get_campaigns

customerio_campaigns_list_broadcast_triggers

customerio_campaigns_list_broadcasts

customerio_campaigns_list_campaign_actions

customerio_campaigns_list_campaigns

customerio_campaigns_update_broadcast_action

customerio_campaigns_update_broadcast_action_language

customerio_campaigns_update_campaign_action

customerio_campaigns_update_campaign_action_translation