Get a web activity
get
/crmRestApi/resources/11.13.18.05/webActivities/{WebActivityNumber}
Request
Path Parameters
-
WebActivityNumber(required): string
The public unique identifier for web activity.
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:
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.
There's no request body for this operation.
Back to TopResponse
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.
Root Schema : webActivities-item-response
Type:
Show Source
object
-
ActivityReferenceId: number
Title:
Activity Reference ID
The activity reference identifier for the web activity. -
CampaignId: integer
(int64)
Title:
Campaign ID
The campaign identifier associated with the web activity. -
CampaignName: string
Title:
Name
Read Only:true
Maximum Length:100
The campaign name associated with the web activity. -
ContactId: integer
(int64)
Title:
Contact ID
The contact party identifier associated with the web activity. -
ContactName: string
Read Only:
true
Maximum Length:360
The contact name associated with the web activity. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the web activity. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the web activity was created. -
ElqActivityDate: string
(date-time)
Title:
Eloqua Activity Date
The date of the web activity. -
ElqActivityId: integer
(int64)
Title:
Eloqua Activity ID
The activity identifier for web activity from the marketing system. -
ElqActivityType: string
Title:
Eloqua Activity Type
Maximum Length:100
The type for web activity. -
ElqAssetId: integer
(int64)
Title:
Eloqua Asset ID
The marketing asset identifier associated with the web activity. -
ElqAssetName: string
Title:
Eloqua Asset Name
Maximum Length:100
The marketing asset name associated with the web activity. -
ElqAssetType: string
Title:
Eloqua Asset Type
Maximum Length:100
The marketing asset type associated with the web activity. -
ElqCampaignId: integer
(int64)
Title:
Eloqua Campaign ID
The marketing campaign identifier associated with the web activity. -
ElqContactId: integer
(int64)
Title:
Eloqua Contact ID
The marketing contact identifier of the contact associated with the web activity. -
ElqDeploymentId: integer
(int64)
Title:
Eloqua Deployment ID
The marketing email deployment identifier associated with the web activity. -
ElqDuration: string
Title:
Eloqua Duration
Maximum Length:100
The duration of web visit activity. -
ElqEmailAddress: string
Title:
Eloqua Email Address
Maximum Length:400
The email address of the contact or lead associated with the web activity. -
ElqEmailClickedThruLink: string
Title:
Eloqua Email Clicked Through Link
Maximum Length:1000
The email click through link associated with the web activity. -
ElqEmailRecipientId: string
Title:
Eloqua Email Recipient ID
Maximum Length:38
The email recipient identifier of the web activity. -
ElqEmailSendType: string
Title:
Eloqua Email Send Type
Maximum Length:100
The marketing email send type associated with the web activity. -
ElqEmailWebLink: string
Title:
Eloqua Email Web Link
Maximum Length:1000
The email web link associated with the web activity. -
ElqExternalId: string
Title:
Eloqua External ID
Maximum Length:20
The external identifier for web activity from the marketing system. -
ElqFirstPageViewURL: string
Title:
Eloqua First Page View URL
Maximum Length:1000
The URL of the first page view activity of a web visit activity. -
ElqNumberOfPages: integer
(int64)
Title:
Eloqua Number of Pages
The number of pages viewed in a web activity of type web visit. -
ElqSubjectLine: string
Title:
Eloqua Subject Line
Maximum Length:500
The email subject line associated with the web activity. -
ElqURL: string
Title:
Eloqua URL
Maximum Length:1000
The URL of the page view activity. -
ElqURLDescription: string
Title:
Eloqua URL Description
Maximum Length:150
The URL description of the web activity. -
ElqWebVisitId: integer
(int64)
Title:
Eloqua Web Visit ID
The web visit identifier associated with the page view activity. -
LastUpdateDate: string
(date-time)
Title:
Last Updated Date
Read Only:true
The date when the web activity was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who late updated the web activity. -
LastUpdateLogin: string
Title:
Last Update Login
Read Only:true
Maximum Length:32
The login of the user who last updated the web activity. -
LeadId: integer
(int64)
Title:
Lead ID
The lead identifier associated with the web activity. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ObjectVersionNumber: integer
(int32)
Title:
Object Version Number
The Version number of the web activity. -
WebActivityId: integer
(int64)
Title:
Web Activity ID
The unique identifier of the web activity. -
WebActivityNumber: string
Title:
Web Activity Number
Maximum Length:64
The public unique identifier for web activity.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
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.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.