Get report by name

POST

/api/report/{projectid}/view-report-for-name

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://api.eventpoint.io/api/report/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/view-report-for-name"),
    Headers =
    {
        { "x-api-key", "<x-api-key>" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

const url = 'https://api.eventpoint.io/api/report/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/view-report-for-name';
const options = {method: 'POST', headers: {'x-api-key': '<x-api-key>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request POST \
  --url https://api.eventpoint.io/api/report/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/view-report-for-name \
  --header 'x-api-key: <x-api-key>'

Authorizations

ApiKeyAuth
BearerAuth

Parameters

Path Parameters

projectid

required

string format: uuid

The project identifier.

Query Parameters

name

string

The report name.

Responses

200

object

reportid

string format: uuid

historyid

string format: uuid

eventtypeid

null | string format: uuid

userid

null | string format: uuid

name

null | string

description

null | string

code

null | string

recordcount

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

lastrefreshed

string format: date-time

columns

Array<object> | null

object

string format: uuid

label

null | string

description

null | string

info

null | string

delimiter

null | string

objtype

null | string

baseobjtype

null | string

view

null | string

objfield

null | string

objid

null | string

ismeta

boolean

iscategory

boolean

property_name

null | string

flatten

boolean

visible

boolean

order

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

dataformat

null | string

timezone

null | string

multiplier

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

showcategoryhierarchy

boolean

formdatatype

One of:

null
unknown

null

allowempty

boolean

calculation

Allowed values: None Count Avg Sum Frequencies Percentage StndDev

dataType

Allowed values: Text Number Date Boolean

statements

Array<object> | null

object

statementid

string format: uuid

name

null | string

logical

Allowed values: AND OR NOT

itemorder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

conditions

Array<object> | null

object

conditionid

string format: uuid

Allowed values: EQ NE GT GTE LT LTE IN NotIn Matches NotMatches

itemorder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

filtertype

null | string

serializedfilter

null | string

reportdata

Array<object> | null

object

string format: uuid

etag

null | string

datarow

null | object

object

reportid

string format: uuid

historyid

string format: uuid

eventtypeid

null | string format: uuid

userid

null | string format: uuid

name

null | string

description

null | string

code

null | string

recordcount

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

lastrefreshed

string format: date-time

columns

Array<object> | null

object

string format: uuid

label

null | string

description

null | string

info

null | string

delimiter

null | string

objtype

null | string

baseobjtype

null | string

view

null | string

objfield

null | string

objid

null | string

ismeta

boolean

iscategory

boolean

property_name

null | string

flatten

boolean

visible

boolean

order

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

dataformat

null | string

timezone

null | string

multiplier

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

showcategoryhierarchy

boolean

formdatatype

One of:

null
unknown

null

allowempty

boolean

calculation

Allowed values: None Count Avg Sum Frequencies Percentage StndDev

dataType

Allowed values: Text Number Date Boolean

statements

Array<object> | null

object

statementid

string format: uuid

name

null | string

logical

Allowed values: AND OR NOT

itemorder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

conditions

Array<object> | null

object

conditionid

string format: uuid

Allowed values: EQ NE GT GTE LT LTE IN NotIn Matches NotMatches

itemorder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

filtertype

null | string

serializedfilter

null | string

reportdata

Array<object> | null

object

string format: uuid

etag

null | string

datarow

null | object

Example

{
  "columns": [
    {
      "formdatatype": "None",
      "calculation": "None",
      "dataType": "Text"
    }
  ],
  "statements": [
    {
      "logical": "AND",
      "conditions": [
        {
          "op": "EQ"
        }
      ]
    }
  ]
}

object

reportid

string format: uuid

historyid

string format: uuid

eventtypeid

null | string format: uuid

userid

null | string format: uuid

name

null | string

description

null | string

code

null | string

recordcount

integer | string format: int64

/^-?(?:0|[1-9]\d*)$/

lastrefreshed

string format: date-time

columns

Array<object> | null

object

string format: uuid

label

null | string

description

null | string

info

null | string

delimiter

null | string

objtype

null | string

baseobjtype

null | string

view

null | string

objfield

null | string

objid

null | string

ismeta

boolean

iscategory

boolean

property_name

null | string

flatten

boolean

visible

boolean

order

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

dataformat

null | string

timezone

null | string

multiplier

null | number | string format: double

/^-?(?:0|[1-9]\d*)(?:\.\d+)?(?:[eE][+-]?\d+)?$/

showcategoryhierarchy

boolean

formdatatype

One of:

null
unknown

null

allowempty

boolean

calculation

Allowed values: None Count Avg Sum Frequencies Percentage StndDev

dataType

Allowed values: Text Number Date Boolean

statements

Array<object> | null

object

statementid

string format: uuid

name

null | string

logical

Allowed values: AND OR NOT

itemorder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

conditions

Array<object> | null

object

conditionid

string format: uuid

Allowed values: EQ NE GT GTE LT LTE IN NotIn Matches NotMatches

itemorder

integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

filtertype

null | string

serializedfilter

null | string

reportdata

Array<object> | null

object

string format: uuid

etag

null | string

datarow

null | object

Example

{
  "columns": [
    {
      "formdatatype": "None",
      "calculation": "None",
      "dataType": "Text"
    }
  ],
  "statements": [
    {
      "logical": "AND",
      "conditions": [
        {
          "op": "EQ"
        }
      ]
    }
  ]
}

403

Forbidden

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

object

type

null | string

title

null | string

status

null | integer | string format: int32

/^-?(?:0|[1-9]\d*)$/

detail

null | string

instance

null | string

Example^generated

{
  "type": "example",
  "title": "example",
  "status": 1,
  "detail": "example",
  "instance": "example"
}

Get report by name

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

Example

403

Examplegenerated

Examplegenerated

Example^generated

Example^generated