Apis::V4::Reports API

get organization days report

Parameters

Name	Description
access_token	JSON Web Token retrieved from the Sessions endpoint (you can also pass this into the Authorization header)

Response Fields

Name	Description	type
data	primary JSON API payload
data[attributes][results]	Hash with information about daily stats	Hash

Request

Headers

Version: HTTP/1.0
Accept: application/vnd.api+json
Content-Type: application/vnd.api+json
Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1c2VyX2lkIjo5MSwiZXhwIjoxNzA0NDczMjI3LCJpYXQiOjE3MDQ0NzMwNDd9.dP5l0TMSGx3T7ILO1MSe4dnZnVCv9hROfD7kq5bh4X4
Host: example.org
Cookie:

Route

GET /apis/v4/reports/organization_days?organization_id=53&period=P10D&end_date=2024-01-05

Query Parameters

organization_id=53
period=P10D
end_date=2024-01-05

Response

Headers

X-Frame-Options: SAMEORIGIN
X-XSS-Protection: 1; mode=block
X-Content-Type-Options: nosniff
X-Download-Options: noopen
X-Permitted-Cross-Domain-Policies: none
Referrer-Policy: strict-origin-when-cross-origin
Content-Type: application/vnd.api+json
Vary: Accept
ETag: W/"602ff461cd147aa6e680e8350d6bfc77"
Cache-Control: max-age=0, private, must-revalidate
X-Request-Id: 2a37484c-2938-4d97-98e1-4278518ce183
X-Runtime: 0.018410
Content-Length: 1225

Status

Body

{
  "data": {
    "id": "53-2023-12-26-2024-01-05",
    "type": "organization_days",
    "attributes": {
      "results": [
        {
          "table": {
            "date": "2023-12-26",
            "interactions_count": 0,
            "stage_results": [
              {
                "table": {
                  "pathway_stage_id": 7,
                  "self_steps": 1,
                  "others_steps": 0
                }
              }
            ],
            "interaction_results": []
          }
        },
        {
          "table": {
            "date": "2023-12-27",
            "interactions_count": 1,
            "stage_results": [],
            "interaction_results": [
              {
                "table": {
                  "interaction_type_id": 1,
                  "count": 1
                }
              }
            ]
          }
        },
        {
          "table": {
            "date": "2023-12-31",
            "interactions_count": 2,
            "stage_results": [
              {
                "table": {
                  "pathway_stage_id": 7,
                  "self_steps": 1,
                  "others_steps": 0
                }
              },
              {
                "table": {
                  "pathway_stage_id": 8,
                  "self_steps": 1,
                  "others_steps": 0
                }
              }
            ],
            "interaction_results": [
              {
                "table": {
                  "interaction_type_id": 1,
                  "count": 2
                }
              }
            ]
          }
        },
        {
          "table": {
            "date": "2024-01-03",
            "interactions_count": 2,
            "stage_results": [],
            "interaction_results": [
              {
                "table": {
                  "interaction_type_id": 1,
                  "count": 2
                }
              }
            ]
          }
        },
        {
          "table": {
            "date": "2024-01-04",
            "interactions_count": 0,
            "stage_results": [
              {
                "table": {
                  "pathway_stage_id": 7,
                  "self_steps": 1,
                  "others_steps": 1
                }
              }
            ],
            "interaction_results": []
          }
        },
        {
          "table": {
            "date": "2024-01-05",
            "interactions_count": 1,
            "stage_results": [],
            "interaction_results": [
              {
                "table": {
                  "interaction_type_id": 1,
                  "count": 1
                }
              }
            ]
          }
        }
      ]
    }
  },
  "meta": {
    "period": "P10D",
    "start_date": "2023-12-26",
    "end_date": "2024-01-05",
    "organization_id": "53"
  }
}