Action performance

Description

Returns action performance in Tines. See Reporting for more information.

Request

HTTP Method: GET

Query Parameter Description
team_id Optional Only show action performance for the selected team
story_id Optional Only show action performance for the selected story
action_id Optional Only show action performance for the selected action
filter_option Optional A string input to only show time saved data for the selected story most_active_actions, action_with_least_activity, slowest_actions or fastest_actions
per_page Optional Set the number of results returned per page. Defaults to 20.
page Optional Specify the page of results to return if there are multiple pages. Defaults to page 1. 
curl -X GET \
  https://<<META.tenant.domain>>/api/v1/reporting/action_performance \
  -H 'content-type: application/json' \
  -H 'Authorization: Bearer <<CREDENTIAL.tines_api_key>>'

Response

A successful response will return a list of action performance data according to the query parameters.

Field description

Parameter Description
action The action of the action run metric returned
average_duration The average time taken for the action to complete
min_duration The shortest time taken for an action to complete
max_duration The longest time taken for an action to complete
processed_count The number of actions completed in a given time frame
story_name The name of the story of the action
recorded_at The recorded time the action was completed at

Sample response

{
  "body": {
    "action_performance": [
      {
        "action": {
          "id": 422,
          "story_id": 30,
          "type": "eventTransformation",
          "name": "Story 2 Action 1",
          "story_container": {
            "id": 16,
            "live_story": {
              "group": false
            }
          }
        },
        "average_duration": 537,
        "min_duration": 537,
        "max_duration": 537,
        "processed_count": 5,
        "story_name": "Story 2",
        "recorded_at": "2024-10-15T15:00:00Z"
      }
    ],
    "meta": {
      "current_page": "http://localhost:3000/api/v1/reporting/action_performance?action_id=422&per_page=20&page=1",
      "previous_page": null,
      "next_page": null,
      "next_page_number": null,
      "per_page": 20,
      "pages": 1,
      "count": 1
    }
  }
}
Was this helpful?