Activity Logs

get

API endpoint that allows activity logs to be created, viewed or edited.

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

log_idstring · max: 25Required

titlestringOptional

descriptionstringOptional

html_descriptionstringOptional

created_bystringRead-onlyRequired

iconstringRead-onlyRequired

time_agostringRead-onlyRequired

avatarstringRead-onlyRequired

get/api/activity/log/

GET /api/activity/log/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

[
  {
    "log_id": "text",
    "title": "text",
    "raw_description": {
      "ANY_ADDITIONAL_PROPERTY": "anything"
    },
    "description": "text",
    "html_description": "text",
    "created_by": "text",
    "icon": "text",
    "time_ago": "text",
    "avatar": "text"
  }
]

post

API endpoint that allows activity logs to be created, viewed or edited.

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Body

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

log_idstring · max: 25Required

titlestringOptional

descriptionstringOptional

html_descriptionstringOptional

created_bystringRead-onlyRequired

iconstringRead-onlyRequired

time_agostringRead-onlyRequired

avatarstringRead-onlyRequired

Responses

201Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

log_idstring · max: 25Required

titlestringOptional

descriptionstringOptional

html_descriptionstringOptional

created_bystringRead-onlyRequired

iconstringRead-onlyRequired

time_agostringRead-onlyRequired

avatarstringRead-onlyRequired

post/api/activity/log/

POST /api/activity/log/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 136

{
  "log_id": "text",
  "title": "text",
  "raw_description": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "html_description": "text"
}

201Success

{
  "log_id": "text",
  "title": "text",
  "raw_description": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "html_description": "text",
  "created_by": "text",
  "icon": "text",
  "time_ago": "text",
  "avatar": "text"
}

get

API endpoint that allows activity logs to be created, viewed or edited.

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters

idstringRequired

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

log_idstring · max: 25Required

titlestringOptional

descriptionstringOptional

html_descriptionstringOptional

created_bystringRead-onlyRequired

iconstringRead-onlyRequired

time_agostringRead-onlyRequired

avatarstringRead-onlyRequired

get/api/activity/log/{id}/

GET /api/activity/log/{id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "log_id": "text",
  "title": "text",
  "raw_description": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "html_description": "text",
  "created_by": "text",
  "icon": "text",
  "time_ago": "text",
  "avatar": "text"
}

Gets the activity log with the given id

get

This endpoint is used to fetch an activity log for the current organization

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Path parameters

module_idstringRequiredPattern: ^\w+$

reference_idstringRequiredPattern: ^\w+$

Responses

200Success

application/json

Serializer for Documents.

Recognized primitve fields:

* ``StringField``
* ``URLField``
* ``EmailField``
* ``IntField``
* ``LongField``
* ``FloatField``
* ``DecimalField``
* ``BooleanField``
* ``DateTimeField``
* ``ComplexDateTimeField``
* ``ObjectIdField``
* ``SequenceField`` (assumes it has integer counter)
* ``UUIDField``
* ``GeoPointField``
* ``GeoJsonBaseField`` (all those fields)
* ``DateField``

Compound fields: ListField and DictField are mapped to corresponding DRF fields, with respect to nested field specification.

The ReferenceField is handled like ForeignKey in DRF: there nested serializer autogenerated if serializer depth greater then 0, otherwise it's handled by it's own (results as str(id)).

For EmbeddedDocumentField also nested serializer autogenerated for non-zero depth, otherwise it is skipped. TODO: THIS IS PROBABLY WRONG AND SHOULD BE FIXED.

Generic fields GenericReferenceField and GenericEmbeddedDocumentField are handled by their own with corresponding serializer fields.

Not well supported or untested:

``FileField``
``ImageField``
``BinaryField``

All other fields are mapped to DocumentField and probably will work wrong.

log_idstring · max: 25Required

titlestringOptional

descriptionstringOptional

html_descriptionstringOptional

created_bystringRead-onlyRequired

iconstringRead-onlyRequired

time_agostringRead-onlyRequired

avatarstringRead-onlyRequired

get/api/activity/log/{module_id}/{reference_id}/

GET /api/activity/log/{module_id}/{reference_id}/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

200Success

{
  "log_id": "text",
  "title": "text",
  "raw_description": {
    "ANY_ADDITIONAL_PROPERTY": "anything"
  },
  "description": "text",
  "html_description": "text",
  "created_by": "text",
  "icon": "text",
  "time_ago": "text",
  "avatar": "text"
}

Track engagement (encrypted)

post

Submit engagement tracking event. Set is_encrypted=True when Angular encrypts sensitive fields (user_obj.email, recipient_email).

Authorizations

AuthorizationstringRequired

JWT token obtained from /api/login/. Pass as: Authorization: Bearer

Body

Other propertiesanyOptional

Responses

201

No response body

No content

500

No response body

post/api/activity/log/track/

POST /api/activity/log/track/ HTTP/1.1
Host: api.app.projetly.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 38

{
  "ANY_ADDITIONAL_PROPERTY": "anything"
}

No content