• query parameters 
  • access_token
  • start_date
  • end_date
  • conversion_v3[office_id]
  • conversion_v3[status] - sign_up, applied, approved, realized, completed
  • conversion_v3[campaign_filter] - provide campaign_id as value

• response example

    "i_accepted_to_approved_time_9": {
      "meta": {},
      "doc_count": 6,
      "children": {
        "doc_count_error_upper_bound": 0,
        "sum_other_doc_count": 0,
        "buckets": [
          {
            "key": 489,
            "doc_count": 1,
            "approval_avg": {
              "value": 1723094976000.0,
              "value_as_string": "2024-08-08T05:29:36.000Z"
            },
            "created_avg": {
              "value": 1723094610552.0,
              "value_as_string": "2024-08-08T05:23:30.552Z"
            }
          },
          {
            "key": 506,
            "doc_count": 1,
            "approval_avg": {
              "value": 1723094976000.0,
              "value_as_string": "2024-08-08T05:29:36.000Z"
            },
            "created_avg": {
              "value": 1723094609765.0,
              "value_as_string": "2024-08-08T05:23:29.765Z"
            }
          },
          {
            "key": 567,
            "doc_count": 1,
            "approval_avg": {
              "value": 1723094977000.0,
              "value_as_string": "2024-08-08T05:29:37.000Z"
            },
            "created_avg": {
              "value": 1723094610358.0,
              "value_as_string": "2024-08-08T05:23:30.358Z"
            }
          },
          {
            "key": 1554,
            "doc_count": 1,
            "approval_avg": {
              "value": 1723094959000.0,
              "value_as_string": "2024-08-08T05:29:19.000Z"
            },
            "created_avg": {
              "value": 1723094610772.0,
              "value_as_string": "2024-08-08T05:23:30.772Z"
            }
          },
          {
            "key": 1577,
            "doc_count": 1,
            "approval_avg": {
              "value": 1723094959000.0,
              "value_as_string": "2024-08-08T05:29:19.000Z"
            },
            "created_avg": {
              "value": 1723094610715.0,
              "value_as_string": "2024-08-08T05:23:30.715Z"
            }
          },
          {
            "key": 1610,
            "doc_count": 1,
            "approval_avg": {
              "value": 1723094976000.0,
              "value_as_string": "2024-08-08T05:29:36.000Z"
            },
            "created_avg": {
              "value": 1723094569031.0,
              "value_as_string": "2024-08-08T05:22:49.031Z"
            }
          }
        ]
      },
      "approval_avg": {
        "value": 1723094970500.0,
        "value_as_string": "2024-08-08T05:29:30.500Z"
      },
      "created_avg": {
        "value": 1723094603532.1667,
        "value_as_string": "2024-08-08T05:23:23.532Z"
      }
    },
    "o_completed_count_9": {
      "meta": {},
      "doc_count": 1,
      "children": {
        "doc_count_error_upper_bound": 0,
        "sum_other_doc_count": 0,
        "buckets": [
          {
            "key": 1709,
            "doc_count": 1,
            "applicants": {
              "value": 1
            }
          }
        ]
      },
      "applicants": {
        "value": 1
      }
    }
    "o_finished_count_7": {
      "meta": {},
      "doc_count": 4,
      "children": {
        "doc_count_error_upper_bound": 0,
        "sum_other_doc_count": 0,
        "buckets": [
          {
            "key": 1552,
            "doc_count": 1,
            "applicants": {
              "value": 1
            }
          },
          {
            "key": 1570,
            "doc_count": 1,
            "applicants": {
              "value": 1
            }
          },
          {
            "key": 1588,
            "doc_count": 1,
            "applicants": {
              "value": 1
            }
          },
          {
            "key": 1617,
            "doc_count": 1,
            "applicants": {
              "value": 1
            }
          }
        ]
      },
      "applicants": {
        "value": 4
      }
    },

• response explanation
  • i_accepted_to_approved_time_9
    • i denotes incoming, and o denotes outgoing.
    • accepted_to_approved_time is the of accepted to approval
    • 9 denotes program ID, other program IDs are 7 and 8
  • for time
    • we can calculate the average from the created-approval average this will give the average time of creation to approval.

    •       "approval_avg": {
              "value": 1723094970500.0,
              "value_as_string": "2024-08-08T05:29:30.500Z"
            },
            "created_avg": {
              "value": 1723094603532.1667,
              "value_as_string": "2024-08-08T05:23:23.532Z"
            }

  • for count
    • we can find a percentage from to/from, for example: finished/completed will give a percentage of finished to completed.
  • for suboffices
    • for suboffices you will use the children key, in this, there will be buckets that will represent suboffices.
    • here, the key is the suboffice ID and applicants. value represents the count for this suboffice in a given time range and status.
    • This applies to both the count and time average.

    • "buckets": [
                {
                  "key": 1552,
                  "doc_count": 1,
                  "applicants": {
                    "value": 1
                  }
                },