activities

Fetches activities related to a project

activities(
  page: Int = 1
  limit: Int
  params: ActivitiesSearch!
  sortBy: ActivitySortByEnum = SORT
  descending: Boolean
): ActivityCollection

Arguments

activities.page ● Int scalar

activities.limit ● Int scalar

activities.params ● ActivitiesSearch! non-null input

activities.sortBy ● ActivitySortByEnum enum

Column name to order. Ex: label

activities.descending ● Boolean scalar

false => ASC or true => DESC

Type

ActivityCollection object

ActivityCollection type

Example request

This generated query uses placeholders for required values. Replace them with values available to your API key before running it.

Before you run it

Run the projects query first and use data.projects.collection[].id as projectId.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"query GetActivities($params: ActivitiesSearch!) {\n  activities(params: $params) { collection { id label title } metadata { currentPage limitValue totalCount } }\n}","variables":{"params":{"projectId":"<project_id>"}}}'

JavaScript

const response = await fetch('https://api.convisoappsec.com/graphql', {
  method: 'POST',
  headers: {
    'content-type': 'application/json',
    'x-api-key': process.env.CONVISO_API_KEY,
  },
  body: JSON.stringify({
    query: "query GetActivities($params: ActivitiesSearch!) {\n  activities(params: $params) { collection { id label title } metadata { currentPage limitValue totalCount } }\n}",
    variables: {
    "params": {
        "projectId": "<project_id>"
    }
},
  }),
});

const { data, errors } = await response.json();

if (errors) throw new Error(errors.map(({ message }) => message).join(', '));
console.log(data);

Python

import json
import os
import requests

response = requests.post(
    'https://api.convisoappsec.com/graphql',
    headers={
        'content-type': 'application/json',
        'x-api-key': os.environ['CONVISO_API_KEY'],
    },
    json={
        'query': "query GetActivities($params: ActivitiesSearch!) {\n  activities(params: $params) { collection { id label title } metadata { currentPage limitValue totalCount } }\n}",
        'variables': json.loads("{\"params\":{\"projectId\":\"<project_id>\"}}"),
    },
    timeout=30,
)
response.raise_for_status()

payload = response.json()
if payload.get('errors'):
    raise RuntimeError(payload['errors'])

print(payload['data'])