1. REST API for Sales and Fusion Service in Oracle Fusion Cloud Customer Experience
  2. Tasks
  3. Web Activities

Get all web activities

get

/crmRestApi/resources/11.13.18.05/webActivities

Request

Query Parameters
  • 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).
  • 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
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • GetContactKeyEventsForEmail: Finds email activities key events for a contact.
      Finder Variables:
      • Bind_ContactId; integer; The unique identifier of the contact.
      • Bind_EmailClickThrough; string; The email click through event.
      • Bind_EmailOpen; string; The email open event.
      • Bind_EmailSend; string; The email send event.
    • GetContactKeyEventsForFormSubmit: Finds form submissions key events for a contact.
      Finder Variables:
      • Bind_ContactId; integer; The unique identifier of the contact.
      • Bind_FormSubmit; string; The form submit event.
    • GetContactKeyEventsForWebVisit: Finds website visits key events for a contact.
      Finder Variables:
      • Bind_ContactId; integer; The unique identifier of the contact.
      • Bind_WebVisit; string; The web visit event.
    • GetKeyEventsForEmail: Finds key events for email activities.
      Finder Variables:
      • Bind_EmailClickThrough; string; The email click through event.
      • Bind_EmailOpen; string; The email open event.
      • Bind_EmailSend; string; The email send event.
      • Bind_LeadId; integer; The unique identifier of the lead.
    • GetKeyEventsForFormSubmit: Finds key events for form submissions.
      Finder Variables:
      • Bind_FormSubmit; string; The form submit event.
      • Bind_LeadId; integer; The unique identifier of the lead.
    • GetKeyEventsForWebVisit: Finds key events for website visits.
      Finder Variables:
      • Bind_LeadId; integer; The unique identifier of the lead.
      • Bind_WebVisit; string; The web visit event.
    • PrimaryKey: Finds web activities for a specified web activity ID.
      Finder Variables:
      • WebActivityId; integer; The unique identifier of the web activity.
    • WebActivityNumberRowFinder: Finds web activity for a specified web activity number.
      Finder Variables:
      • WebActivityNumber; string; The public unique identifier for the web activity.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • 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
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • ActivityReferenceId; number; The activity reference identifier for the web activity.
    • CampaignId; integer; The campaign identifier associated with the web activity.
    • CampaignName; string; The campaign name associated with the web activity.
    • ContactId; integer; The contact party identifier associated with the web activity.
    • ContactName; string; The contact name associated with the web activity.
    • CreatedBy; string; The user who created the web activity.
    • CreationDate; string; The date when the web activity was created.
    • ElqActivityDate; string; The date of the web activity.
    • ElqActivityId; integer; The activity identifier for web activity from the marketing system.
    • ElqActivityType; string; The type for web activity.
    • ElqAssetId; integer; The marketing asset identifier associated with the web activity.
    • ElqAssetName; string; The marketing asset name associated with the web activity.
    • ElqAssetType; string; The marketing asset type associated with the web activity.
    • ElqCampaignId; integer; The marketing campaign identifier associated with the web activity.
    • ElqContactId; integer; The marketing contact identifier of the contact associated with the web activity.
    • ElqDeploymentId; integer; The marketing email deployment identifier associated with the web activity.
    • ElqDuration; string; The duration of web visit activity.
    • ElqEmailAddress; string; The email address of the contact or lead associated with the web activity.
    • ElqEmailClickedThruLink; string; The email click through link associated with the web activity.
    • ElqEmailRecipientId; string; The email recipient identifier of the web activity.
    • ElqEmailSendType; string; The marketing email send type associated with the web activity.
    • ElqEmailWebLink; string; The email web link associated with the web activity.
    • ElqExternalId; string; The external identifier for web activity from the marketing system.
    • ElqFirstPageViewURL; string; The URL of the first page view activity of a web visit activity.
    • ElqNumberOfPages; integer; The number of pages viewed in a web activity of type web visit.
    • ElqSubjectLine; string; The email subject line associated with the web activity.
    • ElqURL; string; The URL of the page view activity.
    • ElqURLDescription; string; The URL description of the web activity.
    • ElqWebVisitId; integer; The web visit identifier associated with the page view activity.
    • LastUpdateDate; string; The date when the web activity was last updated.
    • LastUpdateLogin; string; The login of the user who last updated the web activity.
    • LastUpdatedBy; string; The user who late updated the web activity.
    • LeadId; integer; The lead identifier associated with the web activity.
    • ObjectVersionNumber; integer; The Version number of the web activity.
    • WebActivityId; integer; The unique identifier of the web activity.
    • WebActivityNumber; string; The public unique identifier for web activity.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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 : webActivities
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : webActivities-item-response
Type: object
Show Source
Back to Top