Activity

Retrieve all activities.

One or multiple parameters can be defined to filter the results. ActivityType=[100,101] where ActivityUpdated = 100 and AcccountUpdated = 101. Results will be limited to the last year unless ActivityDateTime is specified, possibly with ActivityDateTime__gt/ActivityDateTime__gte and ActivityDateTime__lt/ActivityDateTime__lte.

get/api/v1/activities

Request

  • Base URL: https://go.outseta.com
  • URL: https://go.outseta.com/api/v1/activities
  • Auth: one of:
    • HTTP bearer
    • API key in header Authorization

Query parameters

EntityTypestring nullable
EntityUidstring nullable
ActivityType10 | 50 | 51 | 52 | 53 | 54 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | 122 | 200 | 201 | 202 | 203 | 204 | 205 | 206 | 207 | 208 | 209 | 210 | 211 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 300 | 301 | 304 | 305 | 306 | 307 | 400 | 401 | 402 | 403 | 500 | 501 | 502 | 503

10 - Custom, 50 - Note, 51 - Email, 52 - PhoneCall, 53 - Meeting, 54 - Chat, 100 - AccountCreated, 101 - AccountUpdated, 102 - AccountAddPerson, 103 - AccountStageUpdated, 104 - AccountDeleted, 105 - AccountBillingInformationUpdated, 106 - AccountSubscriptionPlanUpdated, 107 - AccountSubscriptionPaymentCollected, 108 - AccountSubscriptionPaymentDeclined, 109 - AccountBillingInformationRequested, 110 - AccountBillingInvoiceEmailSent, 111 - AccountRemovePerson, 112 - AccountPaidSubscriptionCreated, 113 - AccountBillingInformationRemoved, 114 - AccountPrimaryPersonUpdated, 115 - AccountBillingInvoiceCreated, 116 - AccountSubscriptionStarted, 117 - AccountSubscriptionRenewalExtended, 118 - AccountSubscriptionAddOnsChanged, 119 - AccountSubscriptionCancellationRequested, 120 - AccountBillingInvoiceDeleted, 121 - AccountPersonRoleUpdated, 122 - AccountProductsChanged, 200 - PersonCreated, 201 - PersonUpdated, 202 - PersonDeleted, 203 - PersonLogin, 204 - PersonListSubscribed, 205 - PersonListUnsubscribed, 206 - PersonSegmentAdded, 207 - PersonSegmentRemoved, 208 - PersonEmailOpened, 209 - PersonEmailClicked, 210 - PersonEmailBounce, 211 - PersonEmailSpam, 212 - PersonSupportTicketCreated, 213 - PersonSupportTicketUpdated, 214 - PersonLeadFormSubmitted, 215 - PersonListConfirmed, 216 - PersonEmailSubscribed, 217 - PersonEmailUnsubscribed, 218 - PersonTemporaryPasswordSet, 219 - PersonSupportTicketClosed, 220 - PersonTwoFactorRecoveryCodesRegenerated, 300 - DealCreated, 301 - DealUpdated, 304 - DealDeleted, 305 - DealDueDate, 306 - TaskCreated, 307 - TaskUpdated, 400 - PlanCreated, 401 - PlanUpdated, 402 - AddOnCreated, 403 - AddOnUpdated, 500 - DiscordUserLinked, 501 - DiscordUserAddedToServer, 502 - DiscordUserRolesUpdated, 503 - DiscordUserRemovedFromServer

ActivityTypesstring[] nullable
ActivityTypestring nullable
EntityTypestring nullable
EntityUidstring nullable
limitinteger

Requested page size. The server caps it at 100, or 25 when requested fields expand child objects or require additional queries; metadata.limit reports the applied value. Use offset=1 for the second page.

offsetinteger

Zero-based page number, not a record offset. With limit=50, the second page is offset=1; offset=50 is page index 50 (records 2501-2550).

Response

Example response

{
  "metadata": {
    "limit": 0,
    "offset": 0,
    "total": 0
  },
  "items": [
    {
      "Uid": "string",
      "_objectType": "string",
      "Created": "string",
      "Updated": "string",
      "ActivityEventData": {},
      "Title": "string",
      "Description": "string",
      "ActivityData": "string",
      "ActivityDateTime": "string",
      "ActivityType": 10,
      "EntityType": 0,
      "EntityUid": "string"
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.