AWorld APIs are in a pre-alpha stage and are being updated frequently. For integration inquiries or technical information, please contact us at server@aworld.org.

Create activity log

PUT

https://api.eu-west-1.aworld.cloud/app/v1/activityLogs

ActivityLogs

Records a user's activity completion by creating a new activity log entry with an auto-generated ID

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PUT 'https://api.eu-west-1.aworld.cloud/app/v1/activityLogs' \
--header 'Content-Type: application/json' \
--data-raw '{
    "activityId": "string",
    "userId": "string",
    "outcome": "SUCCESS",
    "value": 1,
    "tags": [
        "string"
    ],
    "additionalData": {},
    "completedAt": "2019-08-24T14:15:22Z"
}'

Response Example

200 - Example 1

{
    "activityLogId": "string",
    "activityId": "string",
    "userId": "string",
    "outcome": "SUCCESS",
    "value": 1,
    "tags": [
        "string"
    ],
    "additionalData": {},
    "completedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z",
    "accountId": "string",
    "workspaceId": "string",
    "sourceRegion": "string"
}

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

Data required to create a new activity log entry

activityId

string

required

Identifier of the activity that was completed. Must match an existing activity in the system.

>= 2 characters<= 30 characters

Match pattern:

^\S+$

userId

string

required

Identifier of the user who completed the activity

outcome

enum<string>

optional

Result of the activity completion. If not provided, no outcome is recorded.

Allowed values:

SUCCESSFAILURE

value

number

optional

Numerical value associated with the activity completion. Can represent points, progress, or any quantifiable measure.

Default:

1

tags

array[string]

optional

Associated tags for categorization and filtering. Tags can be used to group related activity completions.

additionalData

object

optional

Any additional data related to the activity completion. This can include custom fields specific to the activity type.

completedAt

string <date-time>

required

Timestamp when the activity was completed. Must be in ISO 8601 format.

Examples

Responses

🟢200OK

application/json

Activity log created successfully

Body

Record of a completed activity by a user

activityLogId

string

required

Unique identifier for this activity log entry, generated as a nanoid if not provided

activityId

string

required

Identifier of the activity that was completed

>= 2 characters<= 30 characters

Match pattern:

^\S+$

userId

string

required

Identifier of the user who completed the activity

outcome

enum<string>

optional

Result of the activity completion

Allowed values:

SUCCESSFAILURE

value

number

optional

Numerical value associated with the activity completion

Default:

1

tags

array[string]

optional

Associated tags for categorization and filtering. Can be used for reporting and analytics.

additionalData

object

optional

Any additional data related to the activity completion. This flexible field allows for storing custom information related to the specific activity.

completedAt

string <date-time>

required

Timestamp when the activity was completed

createdAt

string <date-time>

optional

Timestamp when this record was created in the system

updatedAt

string <date-time>

optional

Timestamp when this record was last updated

accountId

string

optional

The account ID associated with this activity log

workspaceId

string

optional

The workspace ID associated with this activity log

sourceRegion

string

optional

AWS region where this activity log was created

🟠400Bad Request

🟠401Unauthorized

🟠404Record Not Found

Modified at 2025-06-25 15:15:28

Get OAuth2 Access Token

Create/update activity log