createAnalysis

Create Analysis

createAnalysis(
  input: CreateProjectInput!
): CreateProjectPayload

Arguments

createAnalysis.input ● CreateProjectInput! non-null input

Parameters for CreateProject

Type

CreateProjectPayload object

Autogenerated return type of CreateProject.

Example request

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

Before you run it

Run the companies query first and use data.companies.collection[].id as companyId.

cURL

curl --request POST https://api.convisoappsec.com/graphql \
  --header "x-api-key: $CONVISO_API_KEY" \
  --header "content-type: application/json" \
  --data '{"query":"mutation MutateCreateAnalysis($input: CreateProjectInput!) {\n  createAnalysis(input: $input) { clientMutationId errors project { id label status } }\n}","variables":{"input":{"goal":"example","label":"example","scope":"example","startDate":"<ISO8601Date>","companyId":1,"typeId":1}}}'

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: "mutation MutateCreateAnalysis($input: CreateProjectInput!) {\n  createAnalysis(input: $input) { clientMutationId errors project { id label status } }\n}",
    variables: {
    "input": {
        "goal": "example",
        "label": "example",
        "scope": "example",
        "startDate": "<ISO8601Date>",
        "companyId": 1,
        "typeId": 1
    }
},
  }),
});

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': "mutation MutateCreateAnalysis($input: CreateProjectInput!) {\n  createAnalysis(input: $input) { clientMutationId errors project { id label status } }\n}",
        'variables': json.loads("{\"input\":{\"goal\":\"example\",\"label\":\"example\",\"scope\":\"example\",\"startDate\":\"<ISO8601Date>\",\"companyId\":1,\"typeId\":1}}"),
    },
    timeout=30,
)
response.raise_for_status()

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

print(payload['data'])