Jump to

• Request
• Response

Get a single Web Activity

get

/API/OData/CampaignAnalysis/1/WebActivities/{key}

Request

Supported Media Types

• application/json
• application/xml

Path Parameters

• key(required): integer(int32)
  WebActivitiesID

Query Parameters

• $count: boolean
  Indicates whether the total count of items within a collection are returned in the result.

  Default Value: false
• $expand: string
  Indicates the related entities to be represented inline. The maximum depth is 2.
• $filter: string
  Restricts the set of items returned. The maximum number of expressions is 100. The allowed functions are: allfunctions.
• $orderby: string
  Specifies the order in which items are returned. The maximum number of expressions is 5.
• $select: string
  Limits the properties returned in the result.
• $skip: integer(int32)
  Excludes the specified number of items of the queried collection from the result.
• $top: integer(int32)
  Limits the number of items returned from a collection. The maximum value is 10000.

Back to Top

Response

Supported Media Types

• application/json
• application/xml

200 Response

WebActivities was successfully retrieved

Body ()

Root Schema : schema

Type: array

Show Source

• Array of: object WebActivities

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WebActivities"
    }
}

Nested Schema : WebActivities

Type: object

Show Source

• calendar: object Calendar
• campaign: object Campaign
• dateHour: string(date-time)
• eloquaCampaignId: integer(int32)
• lastModifiedDate: string(date-time)
• totalPageViews: integer(int32)
• totalVisitors: integer(int32)
• webActivitiesId: integer(int32)

{
    "type":"object",
    "properties":{
        "webActivitiesId":{
            "format":"int32",
            "type":"integer"
        },
        "eloquaCampaignId":{
            "format":"int32",
            "type":"integer"
        },
        "totalPageViews":{
            "format":"int32",
            "type":"integer"
        },
        "totalVisitors":{
            "format":"int32",
            "type":"integer"
        },
        "lastModifiedDate":{
            "format":"date-time",
            "type":"string"
        },
        "dateHour":{
            "format":"date-time",
            "type":"string"
        },
        "campaign":{
            "$ref":"#/definitions/Campaign"
        },
        "calendar":{
            "$ref":"#/definitions/Calendar"
        }
    }
}

Nested Schema : Calendar

Type: object

Show Source

• calendarDayId: string(date-time)
• calendarMonth: integer(int32)
• calendarMonthDesc: string
• calendarMonthId: integer(int32)
• calendarQtr: integer(int32)
• calendarQtrDesc: string
• calendarQtrId: integer(int32)
• calendarWeek: integer(int32)
• calendarWeekDesc: string
• calendarWeekId: integer(int32)
• calendarYear: integer(int32)
• calendarYearDesc: string
• dateHour: string(date-time)
• dayOfMonthNum: integer(int32)
• dayOfWeekDesc: string
• dayOfWeekNum: integer(int32)
• dayOfYearNum: integer(int32)
• displayDayOfWeek: string
• hourOfDayNum: integer(int32)

{
    "type":"object",
    "properties":{
        "dateHour":{
            "format":"date-time",
            "type":"string"
        },
        "calendarYear":{
            "format":"int32",
            "type":"integer"
        },
        "calendarYearDesc":{
            "type":"string"
        },
        "calendarQtr":{
            "format":"int32",
            "type":"integer"
        },
        "calendarQtrDesc":{
            "type":"string"
        },
        "calendarMonth":{
            "format":"int32",
            "type":"integer"
        },
        "calendarMonthDesc":{
            "type":"string"
        },
        "calendarWeek":{
            "format":"int32",
            "type":"integer"
        },
        "calendarWeekDesc":{
            "type":"string"
        },
        "dayOfYearNum":{
            "format":"int32",
            "type":"integer"
        },
        "dayOfWeekNum":{
            "format":"int32",
            "type":"integer"
        },
        "dayOfWeekDesc":{
            "type":"string"
        },
        "dayOfMonthNum":{
            "format":"int32",
            "type":"integer"
        },
        "displayDayOfWeek":{
            "type":"string"
        },
        "hourOfDayNum":{
            "format":"int32",
            "type":"integer"
        },
        "calendarMonthId":{
            "format":"int32",
            "type":"integer"
        },
        "calendarQtrId":{
            "format":"int32",
            "type":"integer"
        },
        "calendarWeekId":{
            "format":"int32",
            "type":"integer"
        },
        "calendarDayId":{
            "format":"date-time",
            "type":"string"
        }
    }
}

Nested Schema : Campaign

Type: object

Show Source

• actualCost: number(double)
• adCampaignId: string
• budgetedCost: number(double)
• campaignClassification: string
• campaignCreatedByUserId: integer(int32)
• campaignCreatedDateTime: string(date-time)
• campaignDescription: string
• campaignEndDate: string(date-time)
• campaignName: string
• campaignProduct: string
• campaignRegion: string
• campaignStartDate: string(date-time)
• campaignStatus: string
• campaignType: string
• crmCampaignId: string
• eloquaCampaignId: integer(int32)
• isDeleted: boolean
• lastActivatedByUserId: integer(int32)
• lastModifiedDate: string(date-time)
• referenceProduct: string

{
    "type":"object",
    "properties":{
        "eloquaCampaignId":{
            "format":"int32",
            "type":"integer"
        },
        "campaignName":{
            "type":"string"
        },
        "crmCampaignId":{
            "type":"string"
        },
        "campaignDescription":{
            "type":"string"
        },
        "campaignCreatedDateTime":{
            "format":"date-time",
            "type":"string"
        },
        "campaignProduct":{
            "type":"string"
        },
        "campaignRegion":{
            "type":"string"
        },
        "campaignType":{
            "type":"string"
        },
        "campaignStatus":{
            "type":"string"
        },
        "isDeleted":{
            "type":"boolean"
        },
        "campaignStartDate":{
            "format":"date-time",
            "type":"string"
        },
        "campaignEndDate":{
            "format":"date-time",
            "type":"string"
        },
        "campaignCreatedByUserId":{
            "format":"int32",
            "type":"integer"
        },
        "lastActivatedByUserId":{
            "format":"int32",
            "type":"integer"
        },
        "lastModifiedDate":{
            "format":"date-time",
            "type":"string"
        },
        "campaignClassification":{
            "type":"string"
        },
        "adCampaignId":{
            "type":"string"
        },
        "referenceProduct":{
            "type":"string"
        },
        "actualCost":{
            "format":"double",
            "type":"number"
        },
        "budgetedCost":{
            "format":"double",
            "type":"number"
        }
    }
}

Back to Top