Reportes personalizados

curl --request GET \
  --url https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID} \
  --header 'apikey: <apikey>'

import requests

url = "https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID}"

headers = {"apikey": "<apikey>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<apikey>'}};

fetch('https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <apikey>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<apikey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<apikey>'

response = http.request(request)
puts response.read_body

{
  "reportId": "REPORTID",
  "data": [
    {
      "date": "2025-01-15",
      "metrics": {
        "total_calls": 150,
        "avg_duration": 320,
        "satisfaction_score": 4.5
      }
    }
  ],
  "pagination": {
    "page": 0,
    "pageSize": 25,
    "total": 100,
    "hasMore": true
  }
}

GET

engine

api

reports

execute-report

{REPORT_ID}

Reportes personalizados

curl --request GET \
  --url https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID} \
  --header 'apikey: <apikey>'

import requests

url = "https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID}"

headers = {"apikey": "<apikey>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {apikey: '<apikey>'}};

fetch('https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "apikey: <apikey>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID}"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("apikey", "<apikey>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{REPORT_ID}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["apikey"] = '<apikey>'

response = http.request(request)
puts response.read_body

{
  "reportId": "REPORTID",
  "data": [
    {
      "date": "2025-01-15",
      "metrics": {
        "total_calls": 150,
        "avg_duration": 320,
        "satisfaction_score": 4.5
      }
    }
  ],
  "pagination": {
    "page": 0,
    "pageSize": 25,
    "total": 100,
    "hasMore": true
  }
}

Los reportes personalizados son reportes configurados específicamente para tus necesidades. Requieren el ID del reporte además de los parámetros estándar.

Endpoint

GET /engine/v1/api/reports/execute-report/{REPORT_ID}

Autenticación

string

required

Tu API Key de autenticación proporcionada por Inconcert.

Parámetros de Ruta

string

required

Identificador único del reporte personalizado que deseas ejecutar.

Puedes obtener el Report ID desde la sección de reportes personalizados en tu panel de administración.

Parámetros de Query

string

required

Identificador único del equipo (crew) para el cual se solicita el reporte.

Puedes obtener el Crew ID desde tu panel de administración en la plataforma InConcert.

string

Permite agrupar los resultados por período de tiempo.Valores posibles: hour, day, week, monthPor defecto: Sin agrupación (dejar vacío)

long

required

Fecha y hora de inicio del período del reporte en formato Unix timestamp (milisegundos).Ejemplo: 1762297200000

long

required

Fecha y hora de fin del período del reporte en formato Unix timestamp (milisegundos).Ejemplo: 1762988399999

integer

required

Número de página para paginación de resultados. Comienza en 0 para la primera página.Ejemplo: 0

integer

required

Cantidad de registros a retornar por página.Ejemplo: 25, 50, 100

string

required

Zona horaria para la interpretación de las fechas. Debe estar codificada en formato URL.Ejemplos:

Europe%2FMadrid (Europa/Madrid)
America%2FNew_York (América/Nueva York)
America%2FSantiago (América/Santiago)

Ejemplo de Petición

curl --location --max-time 10 \
'https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/REPORTID?crew_id=CREWID&groupByTime=&start_ts=1762297200000&end_ts=1762988399999&page=0&pageSize=25&timeZone=Europe%2FMadrid' \
--header 'apikey: XXXXXX'

const reportId = 'REPORTID';
const crewId = 'CREWID';

const params = new URLSearchParams({
  crew_id: crewId,
  groupByTime: '',
  start_ts: '1762297200000',
  end_ts: '1762988399999',
  page: '0',
  pageSize: '25',
  timeZone: 'Europe/Madrid'
});

const response = await fetch(
  `https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/${reportId}?${params}`,
  {
    method: 'GET',
    headers: {
      'apikey': 'XXXXXX'
    }
  }
);

const data = await response.json();
console.log(data);

import requests

report_id = "REPORTID"
crew_id = "CREWID"

url = f"https://api.backend.inconcertcc.com/engine/v1/api/reports/execute-report/{report_id}"

params = {
    "crew_id": crew_id,
    "groupByTime": "",
    "start_ts": 1762297200000,
    "end_ts": 1762988399999,
    "page": 0,
    "pageSize": 25,
    "timeZone": "Europe/Madrid"
}

headers = {
    "apikey": "XXXXXX"
}

response = requests.get(url, params=params, headers=headers, timeout=10)
data = response.json()

print(data)

{
  "reportId": "REPORTID",
  "data": [
    {
      "date": "2025-01-15",
      "metrics": {
        "total_calls": 150,
        "avg_duration": 320,
        "satisfaction_score": 4.5
      }
    }
  ],
  "pagination": {
    "page": 0,
    "pageSize": 25,
    "total": 100,
    "hasMore": true
  }
}

Notas Importantes

Formato de Timestamps

Los parámetros start_ts y end_ts deben estar en formato Unix timestamp expresado en milisegundos (13 dígitos).Para convertir una fecha a timestamp en JavaScript:

const timestamp = new Date('2025-01-15').getTime();
// Resultado: 1736899200000

Codificación de URL

Los parámetros que contengan caracteres especiales (como timeZone) deben estar codificados en formato URL.Ejemplos de codificación:

/ se codifica como %2F
Europe/Madrid → Europe%2FMadrid
America/New_York → America%2FNew_York

Agrupación por Tiempo

El parámetro groupByTime te permite agrupar los resultados:

hour - Agrupa por hora
day - Agrupa por día
week - Agrupa por semana
month - Agrupa por mes
(vacío) - Sin agrupación

Zonas Horarias

El parámetro timeZone afecta la interpretación de las fechas.Asegúrate de usar la zona horaria correcta para tus necesidades, especialmente si operas en múltiples regiones.Zonas horarias comunes:

España: Europe%2FMadrid
Chile: America%2FSantiago
Argentina: America%2FBuenos_Aires
México: America%2FMexico_City

Paginación

Para obtener todos los resultados de un reporte grande, debes realizar múltiples peticiones incrementando el parámetro page mientras haya más resultados disponibles.La API te indicará en la respuesta si hay más páginas disponibles mediante el campo hasMore.

Obtener Report ID

El Report ID lo obtienes desde tu panel de administración:

Accede a la sección “Reportes Personalizados”
Selecciona el reporte que deseas ejecutar
Copia el ID del reporte desde los detalles

Soporte

¿Necesitas ayuda?

Para configurar reportes personalizados o resolver dudas sobre la integración, contacta a nuestro equipo de soporte.

⌘I

Introducción a la API

Endpoints principales

Eventos

Reportes

Reportes personalizados

Endpoint

Autenticación

Parámetros de Ruta

Parámetros de Query

Ejemplo de Petición

Notas Importantes

Soporte

¿Necesitas ayuda?

​Endpoint

​Autenticación

​Parámetros de Ruta

​Parámetros de Query

​Ejemplo de Petición

​Notas Importantes

​Soporte

¿Necesitas ayuda?

Endpoint

Autenticación

Parámetros de Ruta

Parámetros de Query

Ejemplo de Petición

Notas Importantes

Soporte