Jump to

• Request
• Response

Get a campaign rollup

get

/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignRollup/{CampaignId}

Request

Path Parameters

• CampaignId(required): integer(int64)
  The unique identifier of the campaign.
• CampaignNumber(required): string
  The alternate key identifier of the campaign.

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : campaigns-CampaignRollup-item-response

Type: object

Show Source

• CampaignId: integer (int64)
  Title: Campaign Identifier

  Read Only: true

  The unique identifier of the campaign.
• CorpCurrencyCode: string
  Title: Corporate Currency Code

  Read Only: true

  Maximum Length: 15

  The corporate currency code for campaign rollups.
• CreatedBy: string
  Title: Created By

  Read Only: true

  Maximum Length: 64

  The user who created the row.
• CreationDate: string (date-time)
  Title: Creation Date

  Read Only: true

  The date and time when the row was created.
• LastUpdateDate: string (date-time)
  Title: Last Updated Date

  Read Only: true

  The date and time when the row was last updated.
• LastUpdatedBy: string
  Title: Last Updated By

  Read Only: true

  Maximum Length: 64

  The user who last updated the record.
• LastUpdateLogin: string
  Title: Last Update Login

  Read Only: true

  Maximum Length: 32

  The login of the user who last updated the record.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NumberOfContacts: number
  Title: Total Contacts

  Read Only: true

  Number of contacts associated with the campaign.
• NumberOfConvertedLeads: number
  Title: Total Converted Leads

  Read Only: true

  The total number of converted leads associated with the campaign.
• NumberOfEmailActivities: number
  Title: Total Email Activities

  Read Only: true

  Number of email activities associated with the campaign.
• NumberOfEmailClickThroughActivities: number
  Title: Total Email Click-Through Activities

  Read Only: true

  Number of email click-through activities associated with the campaign.
• NumberOfEmailOpenActivities: number
  Title: Total Email Open Activities

  Read Only: true

  Number of email open activities associated with the campaign.
• NumberOfEmailSendActivities: number
  Title: Total Email Send Activities

  Read Only: true

  Number of email send activities associated with the campaign.
• NumberOfEngagedContacts: number
  Title: Total Contacts Engaged

  Read Only: true

  Number of engaged contacts associated with the campaign.
• NumberOfFormSubmitActivities: number
  Title: Total Form Submit Activities

  Read Only: true

  Number of form submission activities associated with the campaign.
• NumberOfLeads: number
  Title: Total Leads

  Read Only: true

  The total number of leads associated with the campaign.
• NumberOfLostOpportunities: number
  Title: Total Lost Opportunities

  Read Only: true

  Total number of Lost opportunities associated with the campaign.
• NumberOfNoSaleOpportunities: number
  Title: Total No Sale Opportunities

  Read Only: true

  Total number of No Sale opportunities associated with the campaign.
• NumberOfOpenHotLeads: number
  Title: Total Hot Open Leads

  Read Only: true

  The total number of unqualified or qualified leads ranked as hot that are associated with the campaign.
• NumberOfOpenLeads: number
  Title: Total Open Leads

  Read Only: true

  The total number of unqualified or qualified open leads associated with the campaign.
• NumberOfOpenOpportunities: number
  Title: Total Open Opportunities

  Read Only: true

  The total number of open opportunities associated with the campaign.
• NumberOfOpportunities: number
  Title: Total Opportunities

  Read Only: true

  The total number of opportunities associated with the campaign.
• NumberOfRetiredLeads: number
  Title: Total Retired Leads

  Read Only: true

  Total number of retired leads for the campaign
• NumberOfWebVisitActivities: number
  Title: Total Web Visit Activities

  Read Only: true

  Number of web visit activities associated with the campaign.
• NumberOfWonOpportunities: number
  Title: Total Won Opportunities

  Read Only: true

  The total won opportunities associated with the campaign.
• SumOfAllOpportunitiesRevenue: number
  Title: Total Revenue from Opportunities

  Read Only: true

  The total revenue of opportunities associated with the campaign.
• SumOfConvertedOpportunitiesRevenue: number
  Title: Total Revenue from Converted Opportunities

  Read Only: true

  Total revenue of the Converted opportunities associated with the campaign.
• SumOfOpenLeadAmount: number
  Title: Total Revenue from Open Leads

  Read Only: true

  The total amount of the unqualified and qualified leads associated with the campaign.
• SumOfOpenOpportunitiesRevenue: number
  Title: Total Revenue from Open Opportunities

  Read Only: true

  The total revenue of the open opportunities associated with the campaign.
• SumOfWonOpportunitiesRevenue: number
  Title: Total Revenue from Won Opportunities

  Read Only: true

  The total revenue of the won opportunities associated with the campaign.

{
    "type":"object",
    "properties":{
        "CampaignId":{
            "title":"Campaign Identifier",
            "type":"integer",
            "description":"The unique identifier of the campaign.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CorpCurrencyCode":{
            "title":"Corporate Currency Code",
            "maxLength":15,
            "type":"string",
            "description":"The corporate currency code for campaign rollups.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the row was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfContacts":{
            "title":"Total Contacts",
            "type":"number",
            "description":"Number of contacts associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfConvertedLeads":{
            "title":"Total Converted Leads",
            "type":"number",
            "description":"The total number of converted leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfEmailActivities":{
            "title":"Total Email Activities",
            "type":"number",
            "description":"Number of email activities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfEmailClickThroughActivities":{
            "title":"Total Email Click-Through Activities",
            "type":"number",
            "description":"Number of email click-through activities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfEmailOpenActivities":{
            "title":"Total Email Open Activities",
            "type":"number",
            "description":"Number of email open activities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfEmailSendActivities":{
            "title":"Total Email Send Activities",
            "type":"number",
            "description":"Number of email send activities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfEngagedContacts":{
            "title":"Total Contacts Engaged",
            "type":"number",
            "description":"Number of engaged contacts associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfFormSubmitActivities":{
            "title":"Total Form Submit Activities",
            "type":"number",
            "description":"Number of form submission activities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfLeads":{
            "title":"Total Leads",
            "type":"number",
            "description":"The total number of leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfLostOpportunities":{
            "title":"Total Lost Opportunities",
            "type":"number",
            "description":"Total number of Lost opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfNoSaleOpportunities":{
            "title":"Total No Sale Opportunities",
            "type":"number",
            "description":"Total number of No Sale opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfOpenHotLeads":{
            "title":"Total Hot Open Leads",
            "type":"number",
            "description":"The total number of unqualified or qualified leads ranked as hot that are associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfOpenLeads":{
            "title":"Total Open Leads",
            "type":"number",
            "description":"The total number of unqualified or qualified open leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfOpenOpportunities":{
            "title":"Total Open Opportunities",
            "type":"number",
            "description":"The total number of open opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfOpportunities":{
            "title":"Total Opportunities",
            "type":"number",
            "description":"The total number of opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfRetiredLeads":{
            "title":"Total Retired Leads",
            "type":"number",
            "description":"Total number of retired leads for the campaign",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfWebVisitActivities":{
            "title":"Total Web Visit Activities",
            "type":"number",
            "description":"Number of web visit activities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "NumberOfWonOpportunities":{
            "title":"Total Won Opportunities",
            "type":"number",
            "description":"The total won opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SumOfAllOpportunitiesRevenue":{
            "title":"Total Revenue from Opportunities",
            "type":"number",
            "description":"The total revenue of opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SumOfConvertedOpportunitiesRevenue":{
            "title":"Total Revenue from Converted Opportunities",
            "type":"number",
            "description":"Total revenue of the Converted opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SumOfOpenLeadAmount":{
            "title":"Total Revenue from Open Leads",
            "type":"number",
            "description":"The total amount of the unqualified and qualified leads associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SumOfOpenOpportunitiesRevenue":{
            "title":"Total Revenue from Open Opportunities",
            "type":"number",
            "description":"The total revenue of the open opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "SumOfWonOpportunitiesRevenue":{
            "title":"Total Revenue from Won Opportunities",
            "type":"number",
            "description":"The total revenue of the won opportunities associated with the campaign.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top