GET
/
users
/
activities
User Activities
curl --request GET \
  --url https://api.forestreet.com/users/activities \
  --header 'x-api-key: <api-key>'
{
    "user": {
        "userId": "960e2b94-781d-4ffc-8711-385d5f06b4b3",
        "email": "john@doe.com"
    },
    "createdAt": "2025-03-19T05:13:00.995Z",
    "capturePeriod": {
        "days": 30
    },
    "markets": [
        {
            "teamId": 141,
            "collectionId": 546,
            "marketId": 5553,
            "marketTitle": "Flexible Packaging in Mexico",
            "marketStatus": "published",
            "marketCreationDate": "2025-02-18T12:16:58.000Z",
            "marketPublishedDate": "2025-02-18T14:50:54.000Z",
            "domainCounts": {
                "include": {
                    "count": 19,
                    "lastOperation": "2025-02-18T14:50:23.000Z"
                },
                "unreviewed": {
                    "count": 31,
                    "lastOperation": null
                },
                "published": {
                    "count": 19,
                    "lastOperation": "2025-02-18T14:50:57.257Z"
                }
            },
            "discoveryHistory": [
                {
                    "user": {
                        "userId": "637d78e5-9fbb-4e61-818f-0b13f7f6a345",
                        "studyUserGroupId": 141
                    },
                    "marketRole": "manufacturer",
                    "seedDomains": [],
                    "locations": [
                        {
                            "country": "MX"
                        }
                    ],
                    "count": 50,
                    "constraints": null,
                    "performSearch": true,
                    "createdAt": "2025-02-18T12:16:58.725Z",
                    "userKeywords": [
                        "laminated film bags"
                    ]
                }
            ]
        },
        {
            "teamId": 141,
            "collectionId": 546,
            "marketId": 5568,
            "marketTitle": "UK Logistics",
            "marketStatus": "draft",
            "marketCreationDate": "2025-02-28T00:04:08.000Z",
            "marketPublishedDate": null,
            "domainCounts": {
                "unreviewed": {
                    "count": 50,
                    "lastOperation": null
                }
            },
            "discoveryHistory": [
                {
                    "user": {
                        "userId": "637d78e5-9fbb-4e61-818f-0b13f7f6a345",
                        "studyUserGroupId": 141
                    },
                    "marketRole": "service provider",
                    "seedDomains": [],
                    "locations": [
                        {
                            "country": "GB"
                        }
                    ],
                    "count": 50,
                    "constraints": null,
                    "performSearch": true,
                    "createdAt": "2025-02-28T00:04:08.601Z",
                    "userKeywords": [
                        "security scanning",
                        "heathrow"
                    ]
                }
            ]
        },
        {
            "teamId": 141,
            "collectionId": 546,
            "marketId": 5569,
            "marketTitle": "Cardboard Boxes",
            "marketStatus": "published",
            "marketCreationDate": "2025-03-04T18:07:24.000Z",
            "marketPublishedDate": "2025-03-04T18:25:09.000Z",
            "domainCounts": {
                "include": {
                    "count": 2,
                    "lastOperation": "2025-03-04T18:24:55.000Z"
                },
                "unreviewed": {
                    "count": 48,
                    "lastOperation": null
                },
                "published": {
                    "count": 2,
                    "lastOperation": "2025-03-04T18:25:10.615Z"
                }
            },
            "discoveryHistory": [
                {
                    "user": {
                        "userId": "637d78e5-9fbb-4e61-818f-0b13f7f6a345",
                        "studyUserGroupId": 141
                    },
                    "marketRole": "manufacturer",
                    "seedDomains": [],
                    "locations": [{}],
                    "count": 50,
                    "constraints": null,
                    "performSearch": true,
                    "createdAt": "2025-03-04T18:07:24.846Z",
                    "userKeywords": []
                }
            ]
        },
        {
            "teamId": 141,
            "collectionId": 546,
            "marketId": 5570,
            "marketTitle": "Cardboard Boxes in Europe",
            "marketStatus": "published",
            "marketCreationDate": "2025-03-04T18:07:46.000Z",
            "marketPublishedDate": "2025-03-04T18:24:41.000Z",
            "domainCounts": {
                "unreviewed": {
                    "count": 48,
                    "lastOperation": null
                },
                "include": {
                    "count": 2,
                    "lastOperation": "2025-03-04T18:24:18.000Z"
                },
                "published": {
                    "count": 2,
                    "lastOperation": "2025-03-04T18:24:44.978Z"
                }
            },
            "discoveryHistory": [
                {
                    "user": {
                        "userId": "637d78e5-9fbb-4e61-818f-0b13f7f6a345",
                        "studyUserGroupId": 141
                    },
                    "marketRole": "manufacturer",
                    "seedDomains": [],
                    "locations": [
                        {
                            "country": "FR"
                        },
                        {
                            "country": "DE"
                        },
                        {
                            "country": "IT"
                        },
                        {
                            "country": "ES"
                        },
                        {
                            "country": "GB"
                        }
                    ],
                    "count": 50,
                    "constraints": null,
                    "performSearch": true,
                    "createdAt": "2025-03-04T18:07:46.728Z",
                    "userKeywords": []
                }
            ]
        }
    ]
}
This endpoint queries the studies accessible to a given user, checks for either:
  • studies that were created in the given time period, or
  • studies that had additional discoveries run in the given time period, or
  • studies that were last published in the given time period,
and returns a object including the
  • Team and Market Collection ID that allows the user’s access to the market,
  • the Market ID,
  • the Market Title,
  • the draft/published status of the market,
  • the creation and publish date of the market,
  • the number of companies in the market by their review and published status, and
  • the discovery history of the market including timestamps for each.
This endpoints serves as a starting point for a management user to generate statistics of a user’s usage and utilisation pattern of the platform.

​
Query

​
uuid
string
The UUID of the user whose activities you want to retrieve.
Only one of the uuid or the email parameter can be provided at a time.
​
email
string
The email of the user whose activities you want to retrieve.
The email must be case-insensitively identical to the email associated with the account; in the case of SSO users, this will be the email provided as the email SAML attribute.

Ensure you include all the necessary components for a strict match, such as any suffixes in the first.last+suffix@your.domain convention.
Only one of the uuid or the email parameter can be provided at a time.
​
days
number
The number of days to look back for the activities.
The maximum number of days is 180.

Only one of days or start and end pair can be provided at a time.
​
start
string
The start date of the period to look for the activities.
The date must be in the YYYY-MM-DD ISO 8601 format.

Only one of days or start and end pair can be provided at a time.
​
end
string
The end date of the period to look for the activities.If not provided, but start is provided, the end date will be set to the current date.
The date must be in the YYYY-MM-DD ISO 8601 format.

Only one of days or start and end pair can be provided at a time.

​
Response

​
user
object
The user object containing the userId and email of the user.

Managed User Object

​
createdAt
string
The time at which this report was generated.This will be in the ISO 8601 format, i.e. YYYY-MM-DDTHH:MM:SS.sssZ, in UTC timezone.
​
capturePeriod
object
The period for which the activities were captured.This simply mirrors the query parameters provided.
​
markets
array
The list of markets that the user interacted with during the capture period. Markets should be unique by their marketId.Each of them contains the following fields:

Market Object

{
    "user": {
        "userId": "960e2b94-781d-4ffc-8711-385d5f06b4b3",
        "email": "john@doe.com"
    },
    "createdAt": "2025-03-19T05:13:00.995Z",
    "capturePeriod": {
        "days": 30
    },
    "markets": [
        {
            "teamId": 141,
            "collectionId": 546,
            "marketId": 5553,
            "marketTitle": "Flexible Packaging in Mexico",
            "marketStatus": "published",
            "marketCreationDate": "2025-02-18T12:16:58.000Z",
            "marketPublishedDate": "2025-02-18T14:50:54.000Z",
            "domainCounts": {
                "include": {
                    "count": 19,
                    "lastOperation": "2025-02-18T14:50:23.000Z"
                },
                "unreviewed": {
                    "count": 31,
                    "lastOperation": null
                },
                "published": {
                    "count": 19,
                    "lastOperation": "2025-02-18T14:50:57.257Z"
                }
            },
            "discoveryHistory": [
                {
                    "user": {
                        "userId": "637d78e5-9fbb-4e61-818f-0b13f7f6a345",
                        "studyUserGroupId": 141
                    },
                    "marketRole": "manufacturer",
                    "seedDomains": [],
                    "locations": [
                        {
                            "country": "MX"
                        }
                    ],
                    "count": 50,
                    "constraints": null,
                    "performSearch": true,
                    "createdAt": "2025-02-18T12:16:58.725Z",
                    "userKeywords": [
                        "laminated film bags"
                    ]
                }
            ]
        },
        {
            "teamId": 141,
            "collectionId": 546,
            "marketId": 5568,
            "marketTitle": "UK Logistics",
            "marketStatus": "draft",
            "marketCreationDate": "2025-02-28T00:04:08.000Z",
            "marketPublishedDate": null,
            "domainCounts": {
                "unreviewed": {
                    "count": 50,
                    "lastOperation": null
                }
            },
            "discoveryHistory": [
                {
                    "user": {
                        "userId": "637d78e5-9fbb-4e61-818f-0b13f7f6a345",
                        "studyUserGroupId": 141
                    },
                    "marketRole": "service provider",
                    "seedDomains": [],
                    "locations": [
                        {
                            "country": "GB"
                        }
                    ],
                    "count": 50,
                    "constraints": null,
                    "performSearch": true,
                    "createdAt": "2025-02-28T00:04:08.601Z",
                    "userKeywords": [
                        "security scanning",
                        "heathrow"
                    ]
                }
            ]
        },
        {
            "teamId": 141,
            "collectionId": 546,
            "marketId": 5569,
            "marketTitle": "Cardboard Boxes",
            "marketStatus": "published",
            "marketCreationDate": "2025-03-04T18:07:24.000Z",
            "marketPublishedDate": "2025-03-04T18:25:09.000Z",
            "domainCounts": {
                "include": {
                    "count": 2,
                    "lastOperation": "2025-03-04T18:24:55.000Z"
                },
                "unreviewed": {
                    "count": 48,
                    "lastOperation": null
                },
                "published": {
                    "count": 2,
                    "lastOperation": "2025-03-04T18:25:10.615Z"
                }
            },
            "discoveryHistory": [
                {
                    "user": {
                        "userId": "637d78e5-9fbb-4e61-818f-0b13f7f6a345",
                        "studyUserGroupId": 141
                    },
                    "marketRole": "manufacturer",
                    "seedDomains": [],
                    "locations": [{}],
                    "count": 50,
                    "constraints": null,
                    "performSearch": true,
                    "createdAt": "2025-03-04T18:07:24.846Z",
                    "userKeywords": []
                }
            ]
        },
        {
            "teamId": 141,
            "collectionId": 546,
            "marketId": 5570,
            "marketTitle": "Cardboard Boxes in Europe",
            "marketStatus": "published",
            "marketCreationDate": "2025-03-04T18:07:46.000Z",
            "marketPublishedDate": "2025-03-04T18:24:41.000Z",
            "domainCounts": {
                "unreviewed": {
                    "count": 48,
                    "lastOperation": null
                },
                "include": {
                    "count": 2,
                    "lastOperation": "2025-03-04T18:24:18.000Z"
                },
                "published": {
                    "count": 2,
                    "lastOperation": "2025-03-04T18:24:44.978Z"
                }
            },
            "discoveryHistory": [
                {
                    "user": {
                        "userId": "637d78e5-9fbb-4e61-818f-0b13f7f6a345",
                        "studyUserGroupId": 141
                    },
                    "marketRole": "manufacturer",
                    "seedDomains": [],
                    "locations": [
                        {
                            "country": "FR"
                        },
                        {
                            "country": "DE"
                        },
                        {
                            "country": "IT"
                        },
                        {
                            "country": "ES"
                        },
                        {
                            "country": "GB"
                        }
                    ],
                    "count": 50,
                    "constraints": null,
                    "performSearch": true,
                    "createdAt": "2025-03-04T18:07:46.728Z",
                    "userKeywords": []
                }
            ]
        }
    ]
}